brec 0.1.3

A flexible binary format for storing and streaming structured data as packets with CRC protection and recoverability from corruption. Built for extensibility and robustness.
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

use thiserror::Error;

#[derive(Error, Debug)]
pub enum Error {
    #[error("Not enought data; required = {0}")]
    NotEnoughData(usize),
    #[error("Not enought data to read signature; data len = {0}; required = {1}")]
    NotEnoughtSignatureData(usize, usize),
    #[error("Invalid data align; data len = {0}; required = {1}; offset = {2} (expected 0)")]
    InvalidAlign(usize, usize, usize),
    #[error("Invalid buffer capacity: {0}; expected: {1}")]
    InvalidCapacity(usize, String),
    #[error("TryFromSliceError: {0}")]
    TryFromSliceError(#[from] std::array::TryFromSliceError),
    #[error("Signature doesn't match to target entity")]
    SignatureDismatch,
    #[error("Crc doesn't match to target entity")]
    CrcDismatch,
    #[error("Same rule has been added already")]
    RuleDuplicate,
    #[error("Block has zero length")]
    ZeroLengthBlock,
    #[error("Attempt to read more blocks than allowed")]
    MaxBlocksCount,
    #[error("Misaligned slice pointer")]
    MisalignedPointer,
    #[error("Unexpected slice length")]
    UnexpectedSliceLength,
    #[error("Fail converting \"{0}\" with error: {1}")]
    FailedConverting(String, String),
    #[error("IO Error: {0}")]
    Io(#[from] std::io::Error),
    #[error("Fail to exctract data from vector for ByteBlock")]
    FailExtractByteBlock,
    #[error("Fail to read payload header")]
    FailToReadPayloadHeader,
    #[error("Memory allocation failed")]
    MemoryAllocationFailed,
    #[error("Encoding error: {0}")]
    EncodeError(String),
    #[error("No pending packet to accept")]
    NoPendingPacket,
    #[error("Fail to read packet header")]
    FailToReadPacketHeader,
    #[error("PacketBufReader fall down into invalid logic")]
    InvalidPacketReaderLogic,
    #[error("Fail to find free slot")]
    CannotFindFreeSlot,
    #[error("Fail to find free palce in slot")]
    CannotFindFreePlaceInSlot,
    #[error("Fail to insert data into slot")]
    CannotInsertIntoSlot,
    #[error("Damaged slot: {0}")]
    DamagedSlot(Box<Error>),
    #[error("Too many attempts to read block; made {0} attempts")]
    TooManyAttemptsToReadBlock(usize),
    #[error("Out of bounds; len = {0}; requested = {1}")]
    OutOfBounds(usize, usize),
}