Enum Error 

#[non_exhaustive]
pub enum Error {
    BufferTooShort {
        need: usize,
        have: usize,
        what: &'static str,
    },
    InvalidSync {
        word: &'static str,
        expected: u16,
        found: u16,
    },
    InvalidValue {
        field: &'static str,
        value: u64,
        reason: &'static str,
    },
    UnsupportedDataMode(DataMode),
    ExtendedPreambleMismatch {
        data_type: u8,
        expected_extended: bool,
        found_extended: bool,
    },
    PayloadTooLarge {
        payload_bits: u32,
        extended_offset_bits: u32,
    },
}

An ST 337 burst parse / serialize error.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BufferTooShort

Input (on parse) or output buffer (on serialize) shorter than required.

Fields

need: usize

Bytes required.

have: usize

Bytes available.

what: &'static str

What was being parsed/serialized.

InvalidSync

Pa or Pb did not equal the fixed 16-bit-mode sync-word constant (SMPTE ST 337 Table 6, §7.2.1).

Fields

word: &'static str

Which sync word ("Pa" or "Pb").

expected: u16

The fixed value Table 6 requires.

found: u16

The value actually found.

InvalidValue

A field value did not fit its wire bit-width, or a derived count (length_code vs. actual payload length) was inconsistent.

Fields

field: &'static str

The offending field/derived-count name.

value: u64

The offending value.

reason: &'static str

Why it is invalid.

UnsupportedDataMode(DataMode)

data_mode (§7.2.4.3 Table 8) was not Mode16. This crate’s byte-stream abstraction only supports the 16-bit data mode — see docs/st337.md’s “Scope decisions” §2 for why 20-/24-bit-wide preamble words are out of scope.

ExtendedPreambleMismatch

data_type == 31 requires the six-word preamble (Pe/Pf present); any other data_type requires the four-word preamble (Pe/Pf absent) — SMPTE ST 337 §7.2.1 Table 6 / §7.2.4.2.

Fields

data_type: u8

The data_type value that determines the required form.

expected_extended: bool

Whether the six-word preamble is required for this data_type.

found_extended: bool

Whether the six-word preamble was actually present.

PayloadTooLarge

A payload (plus, for the six-word preamble, Pe+Pf’s 32 bits) would not fit in the 16-bit-mode length_code’s 0..=65535-bit range (§7.2.5).

Fields

payload_bits: u32

Total bits that would need to be encoded in length_code.

extended_offset_bits: u32

Bits of that total contributed by Pe/Pf (0 or 32).

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Error