fef 0.2.3

Rust implementation of a parser of the FEF 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

//! Public and sealed traits

use crate::{common::traits::private::Sealed, v0::config::Config};

/// Trait for reading a value from bytes with option to fail.
pub trait ReadFrom<T>: Sealed + Sized
where
    T: std::io::Read + ?Sized,
{
    /// The error type that can be returned when reading fails.
    type ReadError: std::error::Error;

    /// Reads a value from the given reader.
    fn read_from<C: ?Sized + Config>(
        reader: &mut T,
        configuration: &C,
    ) -> Result<Self, Self::ReadError>;
}

/// Trait for reading a value from bytes with option to fail with byte length provided.
///
/// Used when parsing of previous parts of the byte stream indicates the length of the value.
pub trait ReadFromWithLength<T>: Sealed + Sized
where
    T: std::io::Read + ?Sized,
{
    /// The error type that can be returned when reading fails.
    type ReadError: std::error::Error;

    /// Reads a value from the given reader.
    fn read_from<C: ?Sized + Config>(
        reader: &mut T,
        configuration: &C,
        byte_length: usize,
    ) -> Result<Self, Self::ReadError>;
}

/// Trait for writing a value to bytes with option to fail.
pub trait WriteTo<W>: Sealed
where
    W: std::io::Write + ?Sized,
{
    /// The error type that can be returned when writing fails.
    type WriteError: std::error::Error;

    /// Writes the value to the given writer.
    fn write_to<C: ?Sized + Config>(
        &self,
        writer: &mut W,
        configuration: &C,
    ) -> Result<(), Self::WriteError>;
}