Struct Header 

pub struct Header {
    pub major: u16,
    pub minor: u16,
    pub mandatory_features: u32,
    pub optional_features: u32,
    pub exactness_profile: u8,
    pub source_format: u8,
    pub universe_id: [u8; 16],
    pub declared_source_len: u64,
}

The parsed, validated fixed header.

Fields

major: u16

Major version.

minor: u16

Minor version.

mandatory_features: u32

Feature bits a decoder must understand.

optional_features: u32

Feature bits a decoder may ignore.

exactness_profile: u8

Exactness profile selector (only EXACT_BYTES is normative).

source_format: u8

Source-format class selector.

universe_id: [u8; 16]

First 16 bytes of SHA-256 over the universe declaration string.

declared_source_len: u64

Declared length of the fully reconstructed source.

Implementations

impl Header

pub fn new( universe_id: [u8; 16], declared_source_len: u64, exactness_profile: u8, source_format: u8, ) -> Self

Build a header for the current format version.

pub fn encode(&self) -> [u8; 64]

Encode the header to exactly HEADER_LEN bytes, computing the CRC.

pub fn decode(bytes: &[u8]) -> Result<Header>

Decode and validate the header from the start of bytes.

pub fn is_opaque(&self) -> bool

True if this header describes the opaque source-format class.

pub fn source_format_supported(&self) -> bool

True if this build has an adapter for the declared source-format class.

Unknown classes fail closed: a descriptor naming a class this build does not implement is refused rather than reinterpreted as opaque.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq for Header

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Header