mutnet 0.7.0

Unsafe-free and allocation-free, no-std network protocol parsing and in-place manipulation library.
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

//! TCP specific errors.

use core::error;
use core::fmt::{Debug, Display, Formatter};

use crate::error::{InvalidChecksumError, NotEnoughHeadroomError, UnexpectedBufferEndError};

/// Error returned when parsing a TCP header.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum ParseTcpError {
    /// The data buffer ended unexpectedly.
    UnexpectedBufferEnd(UnexpectedBufferEndError),
    /// Invalid checksum.
    InvalidChecksum(InvalidChecksumError),
    /// Data offset header smaller than minimum (5).
    DataOffsetHeaderValueTooSmall {
        /// Found data offset header value.
        data_offset_header: usize,
    },
}

impl From<UnexpectedBufferEndError> for ParseTcpError {
    #[inline]
    fn from(value: UnexpectedBufferEndError) -> Self {
        Self::UnexpectedBufferEnd(value)
    }
}

impl From<InvalidChecksumError> for ParseTcpError {
    #[inline]
    fn from(value: InvalidChecksumError) -> Self {
        Self::InvalidChecksum(value)
    }
}

impl Display for ParseTcpError {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::UnexpectedBufferEnd(err) => {
                write!(f, "{err}")
            }
            Self::InvalidChecksum(err) => {
                write!(f, "{err}")
            }
            Self::DataOffsetHeaderValueTooSmall { data_offset_header } => {
                write!(
                    f,
                    "Data offset header value too small, minimum 5 expected, was: {data_offset_header}"
                )
            }
        }
    }
}

impl error::Error for ParseTcpError {}

/// Error returned by methods manipulating the data offset.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum SetDataOffsetError {
    /// Data offset is not within required bounds (5..=15).
    InvalidDataOffset {
        /// Invalid data offset.
        data_offset: usize,
    },
    /// Not enough headroom available.
    NotEnoughHeadroom(NotEnoughHeadroomError),
}

impl Display for SetDataOffsetError {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::InvalidDataOffset { data_offset } => {
                write!(
                    f,
                    "Data offset header value invalid, expected to be between 5 and 15 (inclusive): {data_offset}"
                )
            }
            Self::NotEnoughHeadroom(err) => {
                write!(f, "{err}")
            }
        }
    }
}

impl From<NotEnoughHeadroomError> for SetDataOffsetError {
    #[inline]
    fn from(value: NotEnoughHeadroomError) -> Self {
        Self::NotEnoughHeadroom(value)
    }
}

impl error::Error for SetDataOffsetError {}