Enum FrameType 

#[repr(u16)]
pub enum FrameType {
    HeaderMetadata = 1,
    HeaderIndex = 2,
    HeaderHash = 3,
    FooterHash = 5,
    FooterIndex = 6,
    FooterMetadata = 7,
    PrecederMetadata = 8,
    NTensorFrame = 9,
}

Frame type identifiers (uint16).

The body phase may hold any number of data-object frames. In v3 the registry defines exactly one concrete data-object type, FrameType::NTensorFrame (type 9). Future data-object types slot in at fresh unused numbers without a wire-format version bump. Type 4 is reserved and cannot be emitted nor read — it was occupied by the obsolete v2 NTensorFrame layout.

Variants

HeaderMetadata = 1

HeaderIndex = 2

HeaderHash = 3

FooterHash = 5

FooterIndex = 6

FooterMetadata = 7

PrecederMetadata = 8

Per-object metadata frame that immediately precedes a data-object frame. Carries a GlobalMetadata CBOR with a single-entry base array containing metadata for the next data object. _reserved_ and _extra_ are empty in the preceder.

NTensorFrame = 9

N-dimensional tensor data-object frame — the canonical data-object type in v3. Optionally carries compressed bitmask companions identifying positions of NaN / +Inf / −Inf values in the original input.

Layout: frame header, then the encoded payload (with non-finite values substituted with 0.0 when masks are present), then up to three compressed bitmask blobs, then the CBOR descriptor (with an optional "masks" sub-map carrying per-kind method / offset / length), then the 20-byte type- specific footer [cbor_offset u64][hash u64][ENDF].

See plans/WIRE_FORMAT.md §6.5 for the full frame layout and mask design.

Implementations

impl FrameType

pub fn from_u16(v: u16) -> Result<Self>

pub fn is_data_object(self) -> bool

True for frames that carry a data-object payload.

Structured as a match to leave room for future non-tensor data-object variants (see the frame-type registry comment). In v3 this matches only FrameType::NTensorFrame (type 9).

Trait Implementations

impl Clone for FrameType

fn clone(&self) -> FrameType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameType

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

Formats the value using the given formatter.

impl PartialEq for FrameType

fn eq(&self, other: &FrameType) -> 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 Copy for FrameType

impl Eq for FrameType

impl StructuralPartialEq for FrameType