Struct Burst 

pub struct Burst<'a> {
    pub preamble: BurstPreamble,
    pub payload: &'a [u8],
}

One complete non-PCM data burst: BurstPreamble + burst_payload (SMPTE ST 337 §7.1).

burst_payload is carried as an opaque borrowed byte slice — this crate never interprets or transforms its content (§7.5 defers all payload-content formatting to per-data_type specs; the same “parse the container, not the codec” discipline transmux uses for sample data).

Fields

preamble: BurstPreamble

The burst preamble (Pa..Pd/Pf).

payload: &'a [u8]

The burst payload — opaque bytes, ceil(payload_bits / 8) long, where payload_bits is BurstPreamble::length_code minus 32 when BurstPreamble::extended is Some (§7.2.5).

Implementations

impl<'a> Burst<'a>

pub fn new( data_type: u8, data_mode: DataMode, error_flag: bool, data_type_dependent: u8, data_stream_number: u8, extended: Option<ExtendedPreamble>, payload: &'a [u8], ) -> Result<Self>

Build a new burst from typed preamble fields and a payload, computing length_code for you (payload.len() * 8, plus 32 when extended is Some — §7.2.5/Table 6).

Errors

Error::UnsupportedDataMode if data_mode != DataMode::Mode16; Error::InvalidValue if data_type/data_type_dependent/ data_stream_number exceed their bit widths; Error::ExtendedPreambleMismatch if extended.is_some() disagrees with data_type == EXTENDED_DATA_TYPE_MARKER; Error::PayloadTooLarge if the resulting bit count would exceed MAX_LENGTH_CODE_BITS.

Trait Implementations

impl<'a> Clone for Burst<'a>

fn clone(&self) -> Burst<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Burst<'a>

impl<'a> Debug for Burst<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Burst<'a>

impl<'a> Hash for Burst<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Parse<'a> for Burst<'a>

type Error = Error

The error type this implementer returns. Typically the enclosing crate’s Error enum.

fn parse(bytes: &'a [u8]) -> Result<Self>

Parse bytes as Self. Returns Err(Self::Error) on any protocol violation or buffer underrun.

impl<'a> PartialEq for Burst<'a>

fn eq(&self, other: &Burst<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for Burst<'a>

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for Burst<'_>

type Error = Error

The error type this implementer returns (usually the same as the corresponding Parse impl, but need not be).

fn serialized_len(&self) -> usize

Number of bytes serialize_into will write.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Write the serialised form into buf. Returns the number of bytes written (always equal to serialized_len()).

fn to_bytes(&self) -> Vec<u8>

where Self::Error: Debug,

Convenience: allocate a Vec and serialise into it.

impl<'a> StructuralPartialEq for Burst<'a>