lilliput-core 0.1.0

Low-level implementation of encoding/decoding logic for lilliput format
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

//! Configurations for encoding/decoding.

pub use float::FloatEncoderConfig;
pub use int::IntEncoderConfig;
pub use length::LengthEncoderConfig;

mod float;
mod int;
mod length;

/// Mode used while packing values.
#[cfg_attr(any(test, feature = "testing"), derive(proptest_derive::Arbitrary))]
#[derive(Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[repr(u8)]
pub enum PackingMode {
    /// No packing.
    None = 0,
    /// Packing down to native representations.
    Native = 1,
    /// Packing down to most optimal representations.
    #[default]
    Optimal = 2,
}

impl PackingMode {
    pub(crate) fn is_optimal(self) -> bool {
        self == Self::Optimal
    }
}

/// Configuration used for encoding values.
#[cfg_attr(any(test, feature = "testing"), derive(proptest_derive::Arbitrary))]
#[derive(Default, Clone, PartialEq, Debug)]
pub struct EncoderConfig {
    /// Configuration used for encoding value lengths (in header extensions).
    pub lengths: LengthEncoderConfig,
    /// Configuration used for encoding integer values.
    pub ints: IntEncoderConfig,
    /// Configuration used for encoding floating-point values.
    pub floats: FloatEncoderConfig,
}

impl EncoderConfig {
    /// Sets packing-modes to `packing`, returning `self`.
    pub fn with_packing(mut self, packing: PackingMode) -> Self {
        self.lengths = self.lengths.with_packing(packing);
        self.ints = self.ints.with_packing(packing);
        self.floats = self.floats.with_packing(packing);
        self
    }
}

/// Configuration used for decoding values.
#[cfg_attr(any(test, feature = "testing"), derive(proptest_derive::Arbitrary))]
#[derive(Default, Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct DecoderConfig {}