net-wire 0.1.0

Allocation-free no_std wire views and codecs for network protocols.
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

//! TLS parsing and construction errors.

use core::fmt;

/// Failure to validate a TLS wire layout.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum TlsParseError {
    /// Fewer bytes than a fixed prefix or declared vector were supplied.
    Incomplete {
        /// Required bytes.
        required: usize,
        /// Available bytes.
        available: usize,
    },
    /// A declared vector or value violates its format constraints.
    InvalidValue,
    /// A structured payload has trailing bytes after its required fields.
    TrailingBytes,
}

impl fmt::Display for TlsParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Incomplete {
                required,
                available,
            } => write!(
                f,
                "TLS input is incomplete: need {required} bytes, have {available}"
            ),
            Self::InvalidValue => f.write_str("invalid TLS vector or value"),
            Self::TrailingBytes => f.write_str("TLS payload has trailing bytes"),
        }
    }
}

/// Failure to construct TLS bytes in caller-provided storage.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum TlsBuildError {
    /// An input vector or scalar violates the TLS encoding rules.
    InvalidValue,
    /// A requested length cannot be represented by the TLS field.
    LengthTooLarge,
    /// The caller buffer cannot contain the finished encoding.
    BufferTooShort {
        /// Required bytes.
        required: usize,
        /// Available bytes.
        available: usize,
    },
}

impl fmt::Display for TlsBuildError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidValue => f.write_str("invalid TLS builder value"),
            Self::LengthTooLarge => f.write_str("TLS length is not representable"),
            Self::BufferTooShort {
                required,
                available,
            } => write!(
                f,
                "TLS buffer is too short: need {required} bytes, have {available}"
            ),
        }
    }
}