slice-codec 0.4.0

Library for encoding and decoding Slice types.
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

// Copyright (c) ZeroC, Inc.

use crate::buffer::InputSource;
use crate::decoder::Decoder;
use crate::Result;

/// TODO
pub trait DecodeFrom: Sized {
    /// Decodes a value of this type from the provided decoder.
    fn decode_from(decoder: &mut Decoder<impl InputSource>) -> Result<Self>;
}

// =============================================================================
// Macros to streamline implementing `DecodeFrom` on common types.
// =============================================================================

/// This macro implements [`DecodeFrom`] on a numeric primitive type by calling `from_le_bytes` on it, which constructs
/// a new instance of the type from a series of little-endian bytes. We have to use a macro because there is no common
/// trait for numeric types, they all just happen to have this function with the same name and behavior.
///
/// This works out-of-the-box because both Rust and Slice use two's complement for representing signed integers,
/// and IEEE-754 for floating point numbers.
#[doc(hidden)]
#[macro_export]
macro_rules! implement_decode_from_on_numeric_primitive_type {
    ($ty:ty, $doc_text:literal) => {
        impl DecodeFrom for $ty {
            #[doc = $doc_text]
            fn decode_from(decoder: &mut Decoder<impl InputSource>) -> Result<Self> {
                let bytes = decoder.read_bytes_exact()?;
                Ok(Self::from_le_bytes(*bytes))
            }
        }
    };
}
pub use implement_decode_from_on_numeric_primitive_type; // Re-export the macro so it can be used in other modules.

/// This macro provides the logic for decoding a dictionary's elements, after its size has been decoded, and the
/// dictionary itself has been allocated. We have to use a macro because there is no common trait for dictionary types,
/// and this macro isn't a full implementation because of small differences in how the dictionaries must be constructed.
#[doc(hidden)]
#[macro_export]
macro_rules! decode_dictionary_entries {
    ($dictionary:ident, $decoder:ident, $length:ident) => {
        // Decode each entry, and insert them into the dictionary, one by one.
        for _ in 0..$length {
            let key = $decoder.decode()?;
            let value = $decoder.decode()?;

            // Insert the (key,value) pair into the dictionary. If the decoded key is already present, return an error.
            if $dictionary.insert(key, value).is_some() {
                return Err(InvalidDataErrorKind::DuplicateDictionaryKey.into());
            }
        }
    };
}
pub use decode_dictionary_entries; // Re-export the macro so it can be used in other modules.