strata-rs 0.4.1

Deterministic binary data format with canonical encoding
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

use crate::error::EncodeError;
use crate::value::Value;

pub fn encode_uleb128(mut value: u64, out: &mut Vec<u8>) {
    loop {
        let mut byte = (value & 0x7F) as u8;
        value >>= 7;
        if value != 0 {
            byte |= 0x80;
        }
        out.push(byte);
        if value == 0 {
            break;
        }
    }
}

pub fn encode_sleb128(mut value: i64, out: &mut Vec<u8>) {
    loop {
        let byte = (value & 0x7F) as u8;
        let sign_bit = byte & 0x40;
        value >>= 7;

        let done = (value == 0 && sign_bit == 0) || (value == -1 && sign_bit != 0);

        out.push(if done { byte } else { byte | 0x80 });

        if done {
            break;
        }
    }
}

pub fn encode(value: &Value) -> Result<Vec<u8>, EncodeError> {
    let mut out = Vec::new();
    encode_into(value, &mut out)?;
    Ok(out)
}

fn encode_into(value: &Value, out: &mut Vec<u8>) -> Result<(), EncodeError> {
    match value {
        Value::Null => {
            out.push(0x00);
        }

        Value::Bool(false) => {
            out.push(0x01);
        }

        Value::Bool(true) => {
            out.push(0x02);
        }

        Value::Int(number) => {
            out.push(0x10);
            encode_sleb128(*number, out);
        }

        Value::String(string) => {
            out.push(0x20);

            if !string.is_char_boundary(string.len()) {
                return Err(EncodeError::InvalidUtf8);
            }

            let bytes = string.as_bytes();
            encode_uleb128(bytes.len() as u64, out);
            out.extend_from_slice(bytes);
        }

        Value::Bytes(bytes) => {
            out.push(0x21);
            encode_uleb128(bytes.len() as u64, out);
            out.extend_from_slice(bytes);
        }

        Value::List(items) => {
            out.push(0x30);
            encode_uleb128(items.len() as u64, out);
            for item in items {
                encode_into(item, out)?;
            }
        }

        Value::Map(map) => {
            out.push(0x40);
            encode_uleb128(map.len() as u64, out);

            // BTreeMap guarantees canonical order
            for (key, value) in map {
                // key encoded exactly like a String
                out.push(0x20);

                if !key.is_char_boundary(key.len()) {
                    return Err(EncodeError::InvalidUtf8);
                }

                let key_bytes = key.as_bytes();
                encode_uleb128(key_bytes.len() as u64, out);
                out.extend_from_slice(key_bytes);

                encode_into(value, out)?;
            }
        }
    }

    Ok(())
}