bytevec2 0.3.1

A Rust serialization library that uses byte vectors
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

use errors::{BVExpectedSize, ByteVecError};
use {BVDecodeResult, BVEncodeResult, BVSize};

/// Provides serialization functionality for the implementing types.
pub trait ByteEncodable {
    /// Returns the total length of the byte buffer
    /// than can be obtained through the `encode` method  
    fn get_size<Size>(&self) -> Option<Size>
    where
        Size: BVSize + ByteEncodable;
    /// Returs a byte representation of the original data object
    fn encode<Size>(&self) -> BVEncodeResult<Vec<u8>>
    where
        Size: BVSize + ByteEncodable;
}

/// Provides deserialization functionality for the implementing types.
pub trait ByteDecodable: Sized {
    /// Returns an instance of `Self` obtained from the deserialization of the provided byte buffer.
    fn decode<Size>(bytes: &[u8]) -> BVDecodeResult<Self>
    where
        Size: BVSize + ByteDecodable;
    /// Returns the result of `decode` if `bytes.len()` is less or equal than `limit`
    fn decode_max<Size>(bytes: &[u8], limit: Size) -> BVDecodeResult<Self>
    where
        Size: BVSize + ByteDecodable,
    {
        if bytes.len() <= limit.as_usize() {
            Self::decode::<Size>(bytes)
        } else {
            Err(ByteVecError::BadSizeDecodeError {
                expected: BVExpectedSize::LessOrEqualThan(limit.as_usize()),
                actual: bytes.len(),
            })
        }
    }
}