Enum Error 

#[non_exhaustive]
pub enum Error {
    BufferTooShort {
        need: usize,
        have: usize,
        what: &'static str,
    },
    CrcMismatch {
        computed: u32,
        expected: u32,
    },
    UnexpectedTableId {
        table_id: u8,
    },
    UnexpectedDescriptorTag {
        tag: u8,
        what: &'static str,
        expected: u8,
    },
    UnexpectedCommandType {
        got: u8,
        what: &'static str,
        expected: u8,
    },
    InvalidValue {
        field: &'static str,
        reason: &'static str,
    },
    LengthOverflow {
        declared: usize,
        available: usize,
        what: &'static str,
    },
    OutputBufferTooSmall {
        need: usize,
        have: usize,
    },
}

Error variants that SCTE 35 parsers and builders can return.

Spec references quote clauses from ANSI/SCTE 35 2023r1 where applicable.

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 buffer was shorter than the smallest valid encoding for the type.

Fields

need: usize

Bytes required to proceed.

have: usize

Bytes actually available.

what: &'static str

Human-readable name of the type or field being parsed.

CrcMismatch

CRC-32 validation failed for a splice_info_section (§9.6.1).

Fields

computed: u32

CRC we calculated over the section bytes.

expected: u32

CRC carried at the end of the section.

UnexpectedTableId

table_id byte was not the expected 0xFC (§9.6.1).

Fields

table_id: u8

Byte value actually read.

UnexpectedDescriptorTag

A splice_descriptor_tag byte did not match the value the invoked descriptor parser expected (§10.2.1).

Fields

tag: u8

Tag byte actually read.

what: &'static str

Descriptor parser invoked.

expected: u8

Tag the parser expected.

UnexpectedCommandType

splice_command_type byte did not match the value the invoked command parser expected (§9.6.1, Table 7).

Fields

got: u8

Command type byte actually read.

what: &'static str

Command parser invoked.

expected: u8

Command type the parser expected.

InvalidValue

A field carried a value the structure cannot represent or that violates a spec constraint (e.g. a 33-bit field given a value ≥ 2^33).

Fields

field: &'static str

Field being validated.

reason: &'static str

Why the value is rejected.

LengthOverflow

A declared length (section_length, descriptor_length, …) ran past the bytes available in the buffer.

Fields

declared: usize

Length declared inside the wire header.

available: usize

Bytes actually available.

what: &'static str

What the length describes.

OutputBufferTooSmall

Write buffer passed to serialize_into was smaller than serialized_len().

Fields

need: usize

Required size.

have: usize

Actual size.

Trait Implementations

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error