lencode 1.1.0

A crate for encoding and decoding variable-length data using the Lencode varint encoding scheme and deduplication
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

//! Unified encoding/decoding context that bundles optional deduplication and diff state.

use crate::dedupe::{DedupeDecoder, DedupeEncoder};
use crate::diff::{DiffDecoder, DiffEncoder};

/// Bundles optional [`DedupeEncoder`] and [`DiffEncoder`] state for encoding.
///
/// Pass `Some(&mut EncoderContext)` to [`crate::Encode::encode_ext`] when you
/// want deduplication, diff encoding, or both. Individual components are
/// optional: leave a field `None` to disable that feature.
pub struct EncoderContext {
    /// Optional deduplication encoder.
    pub dedupe: Option<DedupeEncoder>,
    /// Optional diff encoder for byte blobs.
    pub diff: Option<DiffEncoder>,
}

impl Default for EncoderContext {
    fn default() -> Self {
        Self::new()
    }
}

impl EncoderContext {
    /// Creates a new context with no features enabled.
    #[inline(always)]
    pub const fn new() -> Self {
        Self {
            dedupe: None,
            diff: None,
        }
    }

    /// Creates a context with deduplication enabled.
    #[inline(always)]
    pub fn with_dedupe() -> Self {
        Self {
            dedupe: Some(DedupeEncoder::new()),
            diff: None,
        }
    }

    /// Creates a context with diff encoding enabled.
    #[inline(always)]
    pub fn with_diff() -> Self {
        Self {
            dedupe: None,
            diff: Some(DiffEncoder::new()),
        }
    }

    /// Creates a context with both deduplication and diff encoding enabled.
    #[inline(always)]
    pub fn with_all() -> Self {
        Self {
            dedupe: Some(DedupeEncoder::new()),
            diff: Some(DiffEncoder::new()),
        }
    }
}

/// Bundles optional [`DedupeDecoder`] and [`DiffDecoder`] state for decoding.
///
/// Pass `Some(&mut DecoderContext)` to [`crate::Decode::decode_ext`] when you
/// want deduplication, diff decoding, or both.
pub struct DecoderContext {
    /// Optional deduplication decoder.
    pub dedupe: Option<DedupeDecoder>,
    /// Optional diff decoder for byte blobs.
    pub diff: Option<DiffDecoder>,
}

impl Default for DecoderContext {
    fn default() -> Self {
        Self::new()
    }
}

impl DecoderContext {
    /// Creates a new context with no features enabled.
    #[inline(always)]
    pub const fn new() -> Self {
        Self {
            dedupe: None,
            diff: None,
        }
    }

    /// Creates a context with deduplication enabled.
    #[inline(always)]
    pub fn with_dedupe() -> Self {
        Self {
            dedupe: Some(DedupeDecoder::new()),
            diff: None,
        }
    }

    /// Creates a context with diff decoding enabled.
    #[inline(always)]
    pub fn with_diff() -> Self {
        Self {
            dedupe: None,
            diff: Some(DiffDecoder::new()),
        }
    }

    /// Creates a context with both deduplication and diff decoding enabled.
    #[inline(always)]
    pub fn with_all() -> Self {
        Self {
            dedupe: Some(DedupeDecoder::new()),
            diff: Some(DiffDecoder::new()),
        }
    }
}