Enum AnySegment 

#[non_exhaustive]
pub enum AnySegment<'a> {
    PageComposition(PageCompositionSegment),
    RegionComposition(RegionCompositionSegment),
    ClutDefinition(ClutDefinitionSegment),
    ObjectData(ObjectDataSegment<'a>),
    DisplayDefinition(DisplayDefinitionSegment),
    DisparitySignalling(DisparitySignallingSegment),
    AlternativeClut(AlternativeClutSegment),
    EndOfDisplaySet(EndOfDisplaySetSegment),
    Stuffing(StuffingSegment<'a>),
    Unknown {
        segment_type: u8,
        page_id: u16,
        data: &'a [u8],
    },
    Malformed {
        segment_type: u8,
        page_id: u16,
        data: &'a [u8],
        err: Error,
    },
}

Every crate-implemented segment type, plus an Unknown fallthrough.

serde uses external tagging with camelCase variant keys.

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.

PageComposition(PageCompositionSegment)

PageComposition segment.

RegionComposition(RegionCompositionSegment)

RegionComposition segment.

ClutDefinition(ClutDefinitionSegment)

ClutDefinition segment.

ObjectData(ObjectDataSegment<'a>)

ObjectData segment.

DisplayDefinition(DisplayDefinitionSegment)

DisplayDefinition segment.

DisparitySignalling(DisparitySignallingSegment)

DisparitySignalling segment.

AlternativeClut(AlternativeClutSegment)

AlternativeClut segment.

EndOfDisplaySet(EndOfDisplaySetSegment)

EndOfDisplaySet segment.

Stuffing(StuffingSegment<'a>)

Stuffing segment.

Unknown

Segment with an unrecognized or unsupported segment_type; data is the segment body sans the 6-byte header (4 bytes of generic segment framing).

Fields

segment_type: u8

The raw segment_type byte.

page_id: u16

The page_id from the segment header.

data: &'a [u8]

The segment body bytes (starting after the 4-byte sync_byte+segment_type+page_id+segment_length header).

Malformed

Segment with a recognized segment_type whose typed parse returned Err (distinct from Self::Unknown, whose segment_type has no typed implementation at all — issue #1108/DS-W1: a bug that makes every real instance of a typed parser fail could otherwise hide as Unknown passthrough and still round-trip byte-exact). Re-serializes the raw bytes verbatim, same as Unknown.

Fields

segment_type: u8

The raw segment_type byte.

page_id: u16

The page_id from the segment header.

data: &'a [u8]

The segment body bytes (same slicing as Unknown::data).

err: Error

Why the typed parse failed.

Implementations

impl<'a> AnySegment<'a>

pub const DISPATCHED_SEGMENT_TYPES: &'static [u8]

Every segment_type the generated dispatcher routes.

pub fn name(&self) -> &'static str

Diagnostic name of the contained segment — the type’s SegmentDef::NAME ("PAGE_COMPOSITION", "OBJECT_DATA", …); "UNKNOWN" for AnySegment::Unknown, "MALFORMED" for AnySegment::Malformed.

Trait Implementations

impl<'a> Clone for AnySegment<'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 AnySegment<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for AnySegment<'a>

impl<'a> From<AlternativeClutSegment> for AnySegment<'a>

fn from(s: AlternativeClutSegment) -> Self

Converts to this type from the input type.

impl<'a> From<ClutDefinitionSegment> for AnySegment<'a>

fn from(s: ClutDefinitionSegment) -> Self

Converts to this type from the input type.

impl<'a> From<DisparitySignallingSegment> for AnySegment<'a>

fn from(s: DisparitySignallingSegment) -> Self

Converts to this type from the input type.

impl<'a> From<DisplayDefinitionSegment> for AnySegment<'a>

fn from(s: DisplayDefinitionSegment) -> Self

Converts to this type from the input type.

impl<'a> From<EndOfDisplaySetSegment> for AnySegment<'a>

fn from(s: EndOfDisplaySetSegment) -> Self

Converts to this type from the input type.

impl<'a> From<ObjectDataSegment<'a>> for AnySegment<'a>

fn from(s: ObjectDataSegment<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PageCompositionSegment> for AnySegment<'a>

fn from(s: PageCompositionSegment) -> Self

Converts to this type from the input type.

impl<'a> From<RegionCompositionSegment> for AnySegment<'a>

fn from(s: RegionCompositionSegment) -> Self

Converts to this type from the input type.

impl<'a> From<StuffingSegment<'a>> for AnySegment<'a>

fn from(s: StuffingSegment<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for AnySegment<'a>

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

Equality operator ==.

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

Inequality operator !=.

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