Update readme

This commit is contained in:
zrkn 2019-04-26 13:24:48 +03:00
parent 6e575127a7
commit 8060f24cb8
1 changed files with 47 additions and 2 deletions

View File

@ -1,3 +1,48 @@
# rlua Serde
# rlue_serde
(De)serializer implementation for [rlua::Value](https://docs.rs/rlua/0.12/rlua/enum.Value.html)
Implementation of [serde](https://serde.rs/) Serializer/Deserializer for [rlua::Value](https://docs.rs/rlua/0.12/rlua/enum.Value.html)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/rlua_serde.svg)](https://crates.io/crates/rlua_serde)
[![Documentation](https://docs.rs/rlua_serde/badge.svg)][dox]
More information about this crate can be found in the [crate documentation][dox].
[dox]: https://docs.rs/rlua_serde/*/rlua_serde/
## Usage
To use `eventd`, first add this to your `Cargo.toml`:
```toml
[dependencies]
rlua_serde = "0.3"
```
Next, you can use `to_value`/`from_value` functions to serialize/deserialize:
```rust
#[derive(Serialize, Deserialize)]
struct Foo {
bar: u32,
baz: Vec<String>,
}
fn main() {
let lua = rlua::Lua::new();
lua.context(|lua| {
let foo = Foo {
bar: 42,
baz: vec![String::from("fizz"), String::from("buzz")],
};
let value = rlua_serde::to_value(lua, &foo).unwrap();
lua.globals().set("value", value).unwrap();
lua.load(
r#"
assert(value["bar"] == 42)
assert(value["baz"][2] == "buzz")
"#).exec().unwrap();
});
}
```