Struct AdaptationField 

#[non_exhaustive]
pub struct AdaptationField<'a> {
    pub discontinuity_indicator: bool,
    pub random_access_indicator: bool,
    pub elementary_stream_priority_indicator: bool,
    pub pcr: Option<Pcr>,
    pub opcr: Option<Pcr>,
    pub splice_countdown: Option<i8>,
    pub transport_private_data: Option<&'a [u8]>,
    pub extension: Option<AdaptationFieldExtension<'a>>,
    pub pcr_reserved: u8,
    pub opcr_reserved: u8,
    pub stuffing: &'a [u8],
}

Decoded adaptation field — full §2.4.3.4 layout including transport-private data and the adaptation-field extension sub-structure.

The transport_private_data slice borrows from the original packet buffer (it is genuinely opaque caller-defined bytes per the spec — &[u8] is the correct public type). All other fields are fully typed.

ISO/IEC 13818-1:2007 §2.4.3.4.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

discontinuity_indicator: bool

A timing/continuity discontinuity starts at this packet.

random_access_indicator: bool

This packet is a random-access point.

elementary_stream_priority_indicator: bool

Elementary-stream priority hint.

pcr: Option<Pcr>

Program Clock Reference, present iff the PCR flag is set.

opcr: Option<Pcr>

Original PCR, present iff the OPCR flag is set.

splice_countdown: Option<i8>

Splice countdown (packets until the splice point), iff the flag is set.

transport_private_data: Option<&'a [u8]>

Opaque transport-private data (caller-defined; &[u8] is spec-correct here).

Present iff transport_private_data_flag is set in the flags byte (ISO/IEC 13818-1:2007 §2.4.3.4).

extension: Option<AdaptationFieldExtension<'a>>

Typed adaptation-field extension sub-structure, if the flag is set.

pcr_reserved: u8

The 6 reserved bits between program_clock_reference_base and program_clock_reference_extension of the PCR (Table 2-6; spec convention 0b111111). Real streams (e.g. TSDuck’s test-002.ts) carry 0, so the value is kept for a byte-exact round trip. Only meaningful when pcr is Some.

opcr_reserved: u8

The 6 reserved bits of the OPCR (same layout as pcr_reserved).

stuffing: &'a [u8]

The stuffing bytes that pad the adaptation-field body out to its declared adaptation_field_length (ISO/IEC 13818-1 Table 2-6 — “stuffing_byte: fixed 8-bit value 0xFF”).

Real encoders pad the adaptation field so the packet payload begins at a fixed offset; these bytes are part of the wire image. They are kept verbatim (not just counted) so a non-0xFF filler from a non-conforming encoder also round-trips byte-for-byte. Use &[] when constructing an adaptation field with no stuffing.

Implementations

impl<'a> AdaptationField<'a>

pub const fn new() -> Self

An adaptation field with every flag clear, no optional fields, no stuffing and spec-convention reserved bits (all 1). Set fields on the result (the struct is #[non_exhaustive]).

pub fn serialized_len(&self) -> usize

Number of bytes written by serialize_into.

This is the body length excluding the leading adaptation_field_length byte — it is the value carried in that length byte itself (ISO/IEC 13818-1:2007 §2.4.3.4).

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

Serialize the adaptation field into buf.

Writes the body bytes — the flags byte plus optional fields in the order specified by ISO/IEC 13818-1:2007 §2.4.3.4. The adaptation_field_length byte itself is not written here; the caller must prepend it (it equals serialized_len()).

Returns the number of bytes written on success, or Error::OutputBufferTooSmall if buf is shorter than serialized_len().

Trait Implementations

impl<'a> Clone for AdaptationField<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AdaptationField<'a>

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

Formats the value using the given formatter.

impl Default for AdaptationField<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Eq for AdaptationField<'a>

impl<'a> PartialEq for AdaptationField<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for AdaptationField<'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<'a> StructuralPartialEq for AdaptationField<'a>