github/reth
1
1
Fork 0
mirror of https://github.com/paradigmxyz/reth.git synced 2026-01-30 01:28:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: document rlp derive macros (#945)

Browse Source
This commit is contained in:
Matthias Seitz
2023-01-20 18:36:19 +01:00
committed by GitHub
parent a1d83dbbd3
commit d86c9890bd
3 changed files with 39 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/common/rlp-derive/src/de.rs
View File

@@ -1,7 +1,7 @@
use proc_macro2::TokenStream;
use quote::quote;
pub fn impl_decodable(ast: &syn::DeriveInput) -> TokenStream {
pub(crate) fn impl_decodable(ast: &syn::DeriveInput) -> TokenStream {
let body = if let syn::Data::Struct(s) = &ast.data {
s
} else {
@@ -51,7 +51,7 @@ pub fn impl_decodable(ast: &syn::DeriveInput) -> TokenStream {
}
}
pub fn impl_decodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
pub(crate) fn impl_decodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
let body = if let syn::Data::Struct(s) = &ast.data {
s
} else {

6
crates/common/rlp-derive/src/en.rs
View File

@@ -1,7 +1,7 @@
use proc_macro2::TokenStream;
use quote::quote;
pub fn impl_encodable(ast: &syn::DeriveInput) -> TokenStream {
pub(crate) fn impl_encodable(ast: &syn::DeriveInput) -> TokenStream {
let body = if let syn::Data::Struct(s) = &ast.data {
s
} else {
@@ -49,7 +49,7 @@ pub fn impl_encodable(ast: &syn::DeriveInput) -> TokenStream {
}
}
pub fn impl_encodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
pub(crate) fn impl_encodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
let body = if let syn::Data::Struct(s) = &ast.data {
s
} else {
@@ -88,7 +88,7 @@ pub fn impl_encodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
}
}
pub fn impl_max_encoded_len(ast: &syn::DeriveInput) -> TokenStream {
pub(crate) fn impl_max_encoded_len(ast: &syn::DeriveInput) -> TokenStream {
let body = if let syn::Data::Struct(s) = &ast.data {
s
} else {

38
crates/common/rlp-derive/src/lib.rs
View File

@@ -1,3 +1,10 @@
#![warn(missing_docs, unreachable_pub)]
#![deny(unused_must_use)]
#![doc(test(
no_crate_inject,
attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
))]
//! Derive macro for `#[derive(RlpEncodable, RlpDecodable)]`.
//!
//! For example of usage see `./tests/rlp.rs`.
@@ -17,34 +24,57 @@ use de::*;
use en::*;
use proc_macro::TokenStream;
/// Derives `Encodable` for the type which encodes the all fields as list: `<rlp-header, fields...>`
#[proc_macro_derive(RlpEncodable, attributes(rlp))]
pub fn encodable(input: TokenStream) -> TokenStream {
let ast = syn::parse(input).unwrap();
let ast = match syn::parse(input) {
Ok(ast) => ast,
Err(err) => return err.to_compile_error().into(),
};
let gen = impl_encodable(&ast);
gen.into()
}
/// Derives `Encodable` for the type which encodes the fields as-is, without a header: `<fields...>`
#[proc_macro_derive(RlpEncodableWrapper, attributes(rlp))]
pub fn encodable_wrapper(input: TokenStream) -> TokenStream {
let ast = syn::parse(input).unwrap();
let ast = match syn::parse(input) {
Ok(ast) => ast,
Err(err) => return err.to_compile_error().into(),
};
let gen = impl_encodable_wrapper(&ast);
gen.into()
}
/// Derives `MaxEncodedLen` for types of constant size.
#[proc_macro_derive(RlpMaxEncodedLen, attributes(rlp))]
pub fn max_encoded_len(input: TokenStream) -> TokenStream {
let ast = syn::parse(input).unwrap();
let ast = match syn::parse(input) {
Ok(ast) => ast,
Err(err) => return err.to_compile_error().into(),
};
let gen = impl_max_encoded_len(&ast);
gen.into()
}
/// Derives `Decodable` for the type whose implementation expects an rlp-list input: `<rlp-header,
/// fields...>`
///
/// This is the inverse of `RlpEncodable`.
#[proc_macro_derive(RlpDecodable, attributes(rlp))]
pub fn decodable(input: TokenStream) -> TokenStream {
let ast = syn::parse(input).unwrap();
let ast = match syn::parse(input) {
Ok(ast) => ast,
Err(err) => return err.to_compile_error().into(),
};
let gen = impl_decodable(&ast);
gen.into()
}
/// Derives `Decodable` for the type whose implementation expects only the individual fields
/// encoded: `<fields...>`
///
/// This is the inverse of `RlpEncodableWrapper`.
#[proc_macro_derive(RlpDecodableWrapper, attributes(rlp))]
pub fn decodable_wrapper(input: TokenStream) -> TokenStream {
let ast = syn::parse(input).unwrap();