cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Fix failing doc examples in ssz_derive

Browse Source
This commit is contained in:
Paul Hauner 2019-02-20 10:12:18 +13:00
parent a78256c778
commit abef6698b1
No known key found for this signature in database
GPG Key ID: 303E4494BB28068C
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
eth2/utils/ssz_derive/src/lib.rs
View File

@ -11,12 +11,13 @@
//!
//! Example:
//! ```
//! use ssz::{ssz_encode, Decodable, Encodable};
//! use ssz::{ssz_encode, Decodable, Encodable, SszStream, DecodeError};
//! use ssz_derive::{Encode, Decode};
//!
//! #[derive(Encodable, Decodable)]
//! #[derive(Encode, Decode)]
//! struct Foo {
//! bar: bool,
//! baz: u64,
//! pub bar: bool,
//! pub baz: u64,
//! }
//!
//! fn main() {
@ -27,7 +28,7 @@
//!
//! let bytes = ssz_encode(&foo);
//!
//! let decoded_foo = Foo::ssz_decode(bytes, 0).unwrap();
//! let (decoded_foo, _i) = Foo::ssz_decode(&bytes, 0).unwrap();
//!
//! assert_eq!(foo.baz, decoded_foo.baz);
//! }
@ -50,7 +51,7 @@ fn get_named_field_idents<'a>(struct_data: &'a syn::DataStruct) -> Vec<&'a syn::
.collect()
}
/// Implements `ssz::Encodable` on some `struct`.
/// Implements `ssz::Encodable` for some `struct`.
///
/// Fields are encoded in the order they are defined.
#[proc_macro_derive(Encode)]
@ -78,7 +79,7 @@ pub fn ssz_encode_derive(input: TokenStream) -> TokenStream {
output.into()
}
/// Implements `ssz::Decodable` on some `struct`.
/// Implements `ssz::Decodable` for some `struct`.
///
/// Fields are decoded in the order they are defined.
#[proc_macro_derive(Decode)]