alloy_rlp_derive/
lib.rs

1#![doc = include_str!("../README.md")]
2#![doc(
3    html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
4    html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"
5)]
6#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
7
8mod de;
9mod en;
10mod utils;
11
12use de::{impl_decodable, impl_decodable_wrapper};
13use en::{impl_encodable, impl_encodable_wrapper, impl_max_encoded_len};
14use proc_macro::TokenStream;
15
16/// Derives `Encodable` for the type which encodes the all fields as list:
17/// `<rlp-header, fields...>`
18#[proc_macro_derive(RlpEncodable, attributes(rlp))]
19pub fn encodable(input: TokenStream) -> TokenStream {
20    syn::parse(input)
21        .and_then(|ast| impl_encodable(&ast))
22        .unwrap_or_else(|err| err.to_compile_error())
23        .into()
24}
25
26/// Derives `Encodable` for the `newtype` which encodes its single field as-is, without a header:
27/// `<field>`
28#[proc_macro_derive(RlpEncodableWrapper, attributes(rlp))]
29pub fn encodable_wrapper(input: TokenStream) -> TokenStream {
30    syn::parse(input)
31        .and_then(|ast| impl_encodable_wrapper(&ast))
32        .unwrap_or_else(|err| err.to_compile_error())
33        .into()
34}
35
36/// Derives `MaxEncodedLen` for types of constant size.
37#[proc_macro_derive(RlpMaxEncodedLen, attributes(rlp))]
38pub fn max_encoded_len(input: TokenStream) -> TokenStream {
39    syn::parse(input)
40        .and_then(|ast| impl_max_encoded_len(&ast))
41        .unwrap_or_else(|err| err.to_compile_error())
42        .into()
43}
44
45/// Derives `Decodable` for the type whose implementation expects an rlp-list
46/// input: `<rlp-header, fields...>`
47///
48/// This is the inverse of `RlpEncodable`.
49#[proc_macro_derive(RlpDecodable, attributes(rlp))]
50pub fn decodable(input: TokenStream) -> TokenStream {
51    syn::parse(input)
52        .and_then(|ast| impl_decodable(&ast))
53        .unwrap_or_else(|err| err.to_compile_error())
54        .into()
55}
56
57/// Derives `Decodable` for the type whose implementation expects only the
58/// individual fields encoded: `<fields...>`
59///
60/// This is the inverse of `RlpEncodableWrapper`.
61#[proc_macro_derive(RlpDecodableWrapper, attributes(rlp))]
62pub fn decodable_wrapper(input: TokenStream) -> TokenStream {
63    syn::parse(input)
64        .and_then(|ast| impl_decodable_wrapper(&ast))
65        .unwrap_or_else(|err| err.to_compile_error())
66        .into()
67}