elrond-codec 0.16.0

Lightweight binary serializer/deserializer, written especially for Elrond smart contracts
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

extern crate elrond_codec_derive;
use elrond_codec_derive::*;

use elrond_codec::test_util::{check_top_decode, check_top_encode, check_top_encode_decode};

// to test, run the following command in elrond-codec folder:
// cargo expand --test derive_enum_tricky_defaults_test > enum_expanded.rs

/// Enum with default that is not the first variant.
/// Not fieldless, the version with fields.
/// NOT recommended!
#[derive(TopEncodeOrDefault, TopDecodeOrDefault, PartialEq, Eq, Clone, Debug)]
enum TrickyEnumWithDefault {
    FirstVariant,
    SecondVariant,
    VariantWithFields {
        int: u16,
        seq: Vec<u8>,
        another_byte: u8,
        uint_32: u32,
        uint_64: u64,
    },
}

impl elrond_codec::EncodeDefault for TrickyEnumWithDefault {
    fn is_default(&self) -> bool {
        matches!(self, TrickyEnumWithDefault::SecondVariant)
    }
}

impl elrond_codec::DecodeDefault for TrickyEnumWithDefault {
    fn default() -> Self {
        TrickyEnumWithDefault::SecondVariant
    }
}

#[test]
fn tricky_enum_defaults() {
    // the default
    check_top_encode_decode(TrickyEnumWithDefault::SecondVariant, &[]);

    // so this is the tricky bit, FirstVariant also serializes to `&[]`
    // being variant #0, and because we are serializing fieldless enums as top-level u8.
    // TODO: perhaps add an edge case to the code generation?
    // Not sure if worth it, since this is somewhat of an antipattern.
    assert_eq!(check_top_encode(&TrickyEnumWithDefault::FirstVariant), &[]);

    // we can deserialize it from [0], but this is not what gets serialized
    // unlike the fieldless enum, only precisely one "0" byte allowed
    assert_eq!(TrickyEnumWithDefault::FirstVariant, check_top_decode(&[0]));
}