From 8060f24cb866c4eb90a66c708eaa78b9da041348 Mon Sep 17 00:00:00 2001 From: zrkn Date: Fri, 26 Apr 2019 13:24:48 +0300 Subject: [PATCH] Update readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4028ece..cadfd0e 100644 --- a/README.md +++ b/README.md @@ -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, +} + +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(); + }); +} +```