Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

250 changes: 250 additions & 0 deletions lib/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 6 additions & 14 deletions lib/README.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
= IDL Serialization library in Rust

== Using the library
* Import
* Serialization
[source,rust]
#[macro_use]
extern crate serde_idl;
extern crate dfx_info;
use dfx_info::{IDLType};
IDL!(&42, &Some(42), &[1,2,3])
// IDL! macro expands to:
IDLBuilder::new().arg(&42).arg(&Some(42)).arg(&[1,2,3]).to_vec().unwrap(),


* Derive serialization trait and inspect IDL type
[source,rust]
Expand All @@ -19,19 +21,9 @@ assert_eq!(serde_idl::get_type(&list),
field("tail", Type::Opt(Box::new(
Type::Knot(TypeId::of::<List>()))))])
);

* Serialize single argument
[source,rust]
assert_eq!(serde_idl::to_vec(list).unwrap(),
assert_eq!(IDL!(&list),
hex::decode("4449444c026c02a0d2aca8047c90eddae704016e00002a00").unwrap());

* Serialize multiple arguments
[source,rust]
assert_eq!(
IDLBuilder::new().arg(&42).arg(&Some(42)).arg(&[1,2,3]).to_vec().unwrap(),
IDL!(&42, &Some(42), &[1,2,3])
);

== Why not using serde
We end up not using `serde`, since `serde` cannot derive type information, and we cannot easily sort the field index in `struct` and `enum` by the `idl_hash`.

Expand Down
1 change: 1 addition & 0 deletions lib/serde_idl/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ leb128 = "0.2.4"
log = "0.4"
serde = "1.0"
serde_bytes = "0.11"
paste = "0.1"
dfx_info = { path = "../dfx_info" }

[dev-dependencies]
Expand Down
Loading