radix-sbor-derive 1.3.0

A library of macros for deriving Scrypto SBOR and Manifest SBOR implementation, from the Radix DLT project.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use proc_macro2::TokenStream;
use syn::Result;

pub fn handle_scrypto_encode(input: TokenStream) -> Result<TokenStream> {
    sbor_derive_common::encode::handle_encode(
        input,
        Some("radix_common::data::scrypto::ScryptoCustomValueKind"),
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use proc_macro2::TokenStream;
    use quote::quote;
    use std::str::FromStr;

    fn assert_code_eq(a: TokenStream, b: TokenStream) {
        assert_eq!(a.to_string(), b.to_string());
    }

    #[test]
    fn test_encode_struct() {
        let input = TokenStream::from_str("pub struct MyStruct { }").unwrap();
        let output = handle_scrypto_encode(input).unwrap();

        assert_code_eq(
            output,
            quote! {
                impl<E: sbor::Encoder<radix_common::data::scrypto::ScryptoCustomValueKind> >
                    sbor::Encode<radix_common::data::scrypto::ScryptoCustomValueKind, E> for MyStruct
                {
                    #[inline]
                    fn encode_value_kind(&self, encoder: &mut E) -> Result<(), sbor::EncodeError> {
                        encoder.write_value_kind(sbor::ValueKind::Tuple)
                    }
                    #[inline]
                    fn encode_body(&self, encoder: &mut E) -> Result<(), sbor::EncodeError> {
                        use sbor::{self, Encode};
                        encoder.write_size(0usize)?;
                        Ok(())
                    }
                }
            },
        );
    }

    #[test]
    fn test_encode_enum() {
        let input = TokenStream::from_str("enum MyEnum<T: Bound> { A { named: T }, B(String), C }")
            .unwrap();
        let output = handle_scrypto_encode(input).unwrap();

        assert_code_eq(
            output,
            quote! {
                impl<
                        T: Bound,
                        E: sbor::Encoder<radix_common::data::scrypto::ScryptoCustomValueKind>
                    > sbor::Encode<radix_common::data::scrypto::ScryptoCustomValueKind, E> for MyEnum<T>
                where
                    T: sbor::Encode<radix_common::data::scrypto::ScryptoCustomValueKind, E>
                {
                    #[inline]
                    fn encode_value_kind(&self, encoder: &mut E) -> Result<(), sbor::EncodeError> {
                        encoder.write_value_kind(sbor::ValueKind::Enum)
                    }
                    #[inline]
                    fn encode_body(&self, encoder: &mut E) -> Result<(), sbor::EncodeError> {
                        use sbor::{self, Encode};
                        match self {
                            Self::A { named, .. } => {
                                encoder.write_discriminator(0u8)?;
                                encoder.write_size(1usize)?;
                                encoder.encode(named)?;
                            }
                            Self::B(a0) => {
                                encoder.write_discriminator(1u8)?;
                                encoder.write_size(1usize)?;
                                encoder.encode(a0)?;
                            }
                            Self::C => {
                                encoder.write_discriminator(2u8)?;
                                encoder.write_size(0usize)?;
                            }
                        }
                        Ok(())
                    }
                }
            },
        );
    }
}