cartouche 0.1.0

Encoding and decoding for HDMI InfoFrames.
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

/// A hard decode failure.
///
/// Most anomalies encountered while decoding — bad checksum, reserved fields set,
/// unrecognised enum values — are reported as warnings on the returned frame rather
/// than errors. `DecodeError` is returned only when the packet cannot be decoded at
/// all.
///
/// The only current variant is [`DecodeError::Truncated`], which fires when the
/// `length` field in the packet header claims more payload bytes than the 31-byte
/// packet can hold (i.e. `length > 27`).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum DecodeError {
    /// The `length` field in the packet header exceeds the available payload capacity.
    ///
    /// A 31-byte packet can hold at most 27 payload bytes (bytes 4–30). If the header
    /// `length` field declares more than 27, the packet cannot be decoded.
    ///
    /// `claimed` is the value of the `length` field. The available payload
    /// capacity of a 31-byte HDMI packet is always 27 bytes (bytes 4–30).
    Truncated {
        /// The value declared in the packet header's `length` field.
        claimed: u8,
    },
}