borsh 1.7.0

Binary Object Representation Serializer for Hashing
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use crate::common_macro::schema_imports::*;

use core::marker::PhantomData;

#[test]
fn phantom_data_schema() {
    let phantom_declaration = PhantomData::<String>::declaration();
    assert_eq!("()", phantom_declaration);
    let phantom_declaration = PhantomData::<Vec<u8>>::declaration();
    assert_eq!("()", phantom_declaration);
}

#[test]
pub fn generic_struct_with_phantom_data_derived() {
    #[allow(unused)]
    #[derive(borsh::BorshSchema)]
    struct Parametrized<K, V> {
        field: K,
        another: PhantomData<V>,
    }

    assert_eq!(
        "Parametrized<String>".to_string(),
        <Parametrized<String, u32>>::declaration()
    );

    let mut defs = Default::default();
    <Parametrized<String, u32>>::add_definitions_recursively(&mut defs);
    assert_eq!(
        schema_map! {
            "Parametrized<String>" => Definition::Struct {
                fields: Fields::NamedFields(vec![
                    ("field".to_string(), "String".to_string()),
                    ("another".to_string(), "()".to_string())
                ])
            },
            "()" => Definition::Primitive(0),
            "String" => Definition::Sequence {
                length_width: Definition::DEFAULT_LENGTH_WIDTH,
                length_range: Definition::DEFAULT_LENGTH_RANGE,
                elements: "u8".to_string()
            },
            "u8" => Definition::Primitive(1)
        },
        defs
    );
}

#[test]
pub fn generic_enum_variant_with_phantom_data_derived() {
    #[allow(unused)]
    #[derive(borsh::BorshSchema)]
    enum Parametrized<T> {
        Item(PhantomData<T>),
    }

    struct Marker;

    assert_eq!(
        "Parametrized".to_string(),
        <Parametrized<Marker>>::declaration()
    );

    let mut defs = Default::default();
    <Parametrized<Marker>>::add_definitions_recursively(&mut defs);
    assert_eq!(
        schema_map! {
            "Parametrized" => Definition::Enum {
                tag_width: 1,
                variants: vec![
                    (0, "Item".to_string(), "Parametrized__Item".to_string()),
                ],
            },
            "Parametrized__Item" => Definition::Struct {
                fields: Fields::UnnamedFields(vec!["()".to_string()])
            },
            "()" => Definition::Primitive(0)
        },
        defs
    );
}

#[test]
pub fn generic_enum_variant_with_mixed_phantom_data_predicate_derived() {
    #[allow(unused)]
    #[derive(borsh::BorshSchema)]
    enum Parametrized<T, U>
    where
        PhantomData<(T, U)>: Clone,
    {
        Item(PhantomData<T>),
        Other(PhantomData<U>),
    }

    struct Marker;

    assert_eq!(
        "Parametrized".to_string(),
        <Parametrized<Marker, Marker>>::declaration()
    );

    let mut defs = Default::default();
    <Parametrized<Marker, Marker>>::add_definitions_recursively(&mut defs);
    assert_eq!(
        schema_map! {
            "Parametrized" => Definition::Enum {
                tag_width: 1,
                variants: vec![
                    (0, "Item".to_string(), "Parametrized__Item".to_string()),
                    (1, "Other".to_string(), "Parametrized__Other".to_string()),
                ],
            },
            "Parametrized__Item" => Definition::Struct {
                fields: Fields::UnnamedFields(vec!["()".to_string()])
            },
            "Parametrized__Other" => Definition::Struct {
                fields: Fields::UnnamedFields(vec!["()".to_string()])
            },
            "()" => Definition::Primitive(0)
        },
        defs
    );
}