ixc_schema 0.0.4

Interchain SDK Schema
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

use crate::binary::encoder::encode_value;
use crate::buffer::{WriterFactory, Writer};
use crate::codec::ValueEncodeVisitor;
use crate::decoder::{DecodeError, Decoder};
use crate::encoder::{EncodeError, Encoder};
use crate::fields::FieldTypes;
use crate::mem::MemoryManager;
use crate::state_object::field_types::unnamed_struct_type;
use crate::state_object::value_field::ObjectFieldValue;
use crate::structs::{StructDecodeVisitor, StructEncodeVisitor, StructType};
use crate::value::SchemaValue;

/// Encode an object value.
pub fn encode_object_value<'a, 'b, V: ObjectValue>(value: &V::In<'b>, writer_factory: &'a dyn WriterFactory) -> Result<&'a [u8], EncodeError> {
    struct Visitor<'c, 'd, U:ObjectValue>(&'c U::In<'d>);
    impl <'c, 'd, U:ObjectValue> ValueEncodeVisitor for Visitor<'c, 'd, U> {
        fn encode(&self, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
            U::encode(self.0, encoder)
        }
    }
    encode_value(&Visitor::<V>(value), writer_factory)
}

/// Decode an object value.
pub fn decode_object_value<'a, V: ObjectValue>(input: &'a [u8], memory_manager: &'a MemoryManager) -> Result<V::Out<'a>, DecodeError> {
    let mut decoder = crate::binary::decoder::Decoder { buf: input, scope: memory_manager };
    V::decode(&mut decoder, memory_manager)
}

/// This trait is implemented for types that can be used as tuples of value fields in state objects.
pub trait ObjectValue {
    /// The object value types as field types.
    type FieldTypes<'a>: FieldTypes;
    /// The type that is used when inputting object values to functions.
    type In<'a>;
    /// The type that is used in function return values.
    type Out<'a>;
    /// The associated "pseudo-struct" type for the object value.
    const PSEUDO_TYPE: StructType<'static>;

    /// Encode each part of the value in reverse order.
    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError>;

    /// Decode the value from the decoder.
    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError>;
}

impl ObjectValue for () {
    type FieldTypes<'a> = ();
    type In<'a> = ();
    type Out<'a> = ();
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        Ok(())
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        Ok(())
    }
}

impl<A: ObjectFieldValue> ObjectValue for A {
    type FieldTypes<'a> = (<<A as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type,);
    type In<'a> = A::In<'a>;
    type Out<'a> = A::Out<'a>;
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        struct Visitor<'b, A>(&'b A);
        unsafe impl <'b, 'a:'b, A: SchemaValue<'a>> StructEncodeVisitor for Visitor<'b, A> {
            fn encode_field(&self, index: usize, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::encode(&self.0, encoder),
                    _ =>
                        Err(EncodeError::UnknownError),
                }
            }
        }

        encoder.encode_struct(&Visitor(value), &Self::PSEUDO_TYPE)
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        struct Visitor<'a, A: SchemaValue<'a>>(A::DecodeState);
        unsafe impl <'a, A: SchemaValue<'a>> StructDecodeVisitor<'a> for Visitor<'a, A> {
            fn decode_field(&mut self, index: usize, decoder: &mut dyn Decoder<'a>) -> Result<(), DecodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::visit_decode_state(&mut self.0, decoder),
                    _ => Err(DecodeError::UnknownFieldNumber),
                }
            }
        }

        let mut visitor: Visitor<'a, A::Out<'a>> = Visitor(Default::default());
        decoder.decode_struct(&mut visitor, &Self::PSEUDO_TYPE)?;
        Ok(<A::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.0, mem)?)
    }
}

impl<A: ObjectFieldValue> ObjectValue for (A,) {
    type FieldTypes<'a> = (<<A as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type,);
    type In<'a> = (A::In<'a>,);
    type Out<'a> = (A::Out<'a>,);
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        struct Visitor<'b, A>(&'b (A,));
        unsafe impl <'b, 'a:'b, A: SchemaValue<'a>> StructEncodeVisitor for Visitor<'b, A> {
            fn encode_field(&self, index: usize, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::encode(&self.0.0, encoder),
                    _ =>
                        Err(EncodeError::UnknownError),
                }
            }
        }

        encoder.encode_struct(&Visitor(value), &Self::PSEUDO_TYPE)
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        Ok((<A as ObjectValue>::decode(decoder, mem)?,))
    }
}

impl<A: ObjectFieldValue, B: ObjectFieldValue> ObjectValue for (A, B) {
    type FieldTypes<'a> = (<<A as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<B as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type);
    type In<'a> = (A::In<'a>, B::In<'a>);
    type Out<'a> = (A::Out<'a>, B::Out<'a>);
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        struct EncodeVisitor<'b, A, B>(&'b (A, B));
        unsafe impl <'b, 'a:'b, A: SchemaValue<'a>, B: SchemaValue<'a>> StructEncodeVisitor for EncodeVisitor<'b, A, B> {
            fn encode_field(&self, index: usize, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::encode(&self.0.0, encoder),
                    1 => <B as SchemaValue<'a>>::encode(&self.0.1, encoder),
                    _ =>
                        Err(EncodeError::UnknownError),
                }
            }
        }

        encoder.encode_struct(&EncodeVisitor(value), &Self::PSEUDO_TYPE)
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        struct Visitor<'a, A: SchemaValue<'a>, B: SchemaValue<'a>>(A::DecodeState, B::DecodeState);
        unsafe impl <'a, A: SchemaValue<'a>, B: SchemaValue<'a>> StructDecodeVisitor<'a> for Visitor<'a, A, B> {
            fn decode_field(&mut self, index: usize, decoder: &mut dyn Decoder<'a>) -> Result<(), DecodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::visit_decode_state(&mut self.0, decoder),
                    1 => <B as SchemaValue<'a>>::visit_decode_state(&mut self.1, decoder),
                    _ => Err(DecodeError::UnknownFieldNumber),
                }
            }
        }

        let mut visitor: Visitor<'a, A::Out<'a>, B::Out<'a>> = Visitor(Default::default(), Default::default());
        decoder.decode_struct(&mut visitor, &Self::PSEUDO_TYPE)?;
        Ok((
            <A::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.0, mem)?,
            <B::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.1, mem)?,
        ))
    }
}

impl<A: ObjectFieldValue, B: ObjectFieldValue, C: ObjectFieldValue> ObjectValue for (A, B, C) {
    type FieldTypes<'a> = (<<A as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<B as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<C as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type);
    type In<'a> = (A::In<'a>, B::In<'a>, C::In<'a>);
    type Out<'a> = (A::Out<'a>, B::Out<'a>, C::Out<'a>);
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        struct EncodeVisitor<'b, A, B, C>(&'b (A, B, C));
        unsafe impl <'b, 'a:'b, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>> StructEncodeVisitor for EncodeVisitor<'b, A, B, C> {
            fn encode_field(&self, index: usize, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::encode(&self.0.0, encoder),
                    1 => <B as SchemaValue<'a>>::encode(&self.0.1, encoder),
                    2 => <C as SchemaValue<'a>>::encode(&self.0.2, encoder),
                    _ =>
                        Err(EncodeError::UnknownError),
                }
            }
        }

        encoder.encode_struct(&EncodeVisitor(value), &Self::PSEUDO_TYPE)
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        struct Visitor<'a, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>>(A::DecodeState, B::DecodeState, C::DecodeState);
        unsafe impl <'a, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>> StructDecodeVisitor<'a> for Visitor<'a, A, B, C> {
            fn decode_field(&mut self, index: usize, decoder: &mut dyn Decoder<'a>) -> Result<(), DecodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::visit_decode_state(&mut self.0, decoder),
                    1 => <B as SchemaValue<'a>>::visit_decode_state(&mut self.1, decoder),
                    2 => <C as SchemaValue<'a>>::visit_decode_state(&mut self.2, decoder),
                    _ => Err(DecodeError::UnknownFieldNumber),
                }
            }
        }

        let mut visitor: Visitor<'a, A::Out<'a>, B::Out<'a>, C::Out<'a>> = Visitor(Default::default(), Default::default(), Default::default());
        decoder.decode_struct(&mut visitor, &Self::PSEUDO_TYPE)?;
        Ok((
            <A::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.0, mem)?,
            <B::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.1, mem)?,
            <C::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.2, mem)?,
        ))
    }
}

impl<A: ObjectFieldValue, B: ObjectFieldValue, C: ObjectFieldValue, D: ObjectFieldValue> ObjectValue for (A, B, C, D) {
    type FieldTypes<'a> = (<<A as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<B as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<C as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type, <<D as ObjectFieldValue>::In<'a> as SchemaValue<'a>>::Type);
    type In<'a> = (A::In<'a>, B::In<'a>, C::In<'a>, D::In<'a>);
    type Out<'a> = (A::Out<'a>, B::Out<'a>, C::Out<'a>, D::Out<'a>);
    const PSEUDO_TYPE: StructType<'static> = unnamed_struct_type::<Self::FieldTypes<'static>>();

    fn encode<'a>(value: &Self::In<'a>, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
        struct EncodeVisitor<'b, A, B, C, D>(&'b (A, B, C, D));
        unsafe impl <'b, 'a:'b, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>, D: SchemaValue<'a>> StructEncodeVisitor for EncodeVisitor<'b, A, B, C, D> {
            fn encode_field(&self, index: usize, encoder: &mut dyn Encoder) -> Result<(), EncodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::encode(&self.0.0, encoder),
                    1 => <B as SchemaValue<'a>>::encode(&self.0.1, encoder),
                    2 => <C as SchemaValue<'a>>::encode(&self.0.2, encoder),
                    3 => <D as SchemaValue<'a>>::encode(&self.0.3, encoder),
                    _ =>
                        Err(EncodeError::UnknownError),
                }
            }
        }

        encoder.encode_struct(&EncodeVisitor(value), &Self::PSEUDO_TYPE)
    }

    fn decode<'a>(decoder: &mut dyn Decoder<'a>, mem: &'a MemoryManager) -> Result<Self::Out<'a>, DecodeError> {
        struct Visitor<'a, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>, D: SchemaValue<'a>>(A::DecodeState, B::DecodeState, C::DecodeState, D::DecodeState);
        unsafe impl <'a, A: SchemaValue<'a>, B: SchemaValue<'a>, C: SchemaValue<'a>, D: SchemaValue<'a>> StructDecodeVisitor<'a> for Visitor<'a, A, B, C, D> {
            fn decode_field(&mut self, index: usize, decoder: &mut dyn Decoder<'a>) -> Result<(), DecodeError> {
                match index {
                    0 => <A as SchemaValue<'a>>::visit_decode_state(&mut self.0, decoder),
                    1 => <B as SchemaValue<'a>>::visit_decode_state(&mut self.1, decoder),
                    2 => <C as SchemaValue<'a>>::visit_decode_state(&mut self.2, decoder),
                    3 => <D as SchemaValue<'a>>::visit_decode_state(&mut self.3, decoder),
                    _ => Err(DecodeError::UnknownFieldNumber),
                }
            }
        }

        let mut visitor: Visitor<'a, A::Out<'a>, B::Out<'a>, C::Out<'a>, D::Out<'a>> = Visitor(Default::default(), Default::default(), Default::default(), Default::default());
        decoder.decode_struct(&mut visitor, &Self::PSEUDO_TYPE)?;
        Ok((
            <A::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.0, mem)?,
            <B::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.1, mem)?,
            <C::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.2, mem)?,
            <D::Out<'a> as SchemaValue<'a>>::finish_decode_state(visitor.3, mem)?,
        ))
    }
}