Struct Header 

pub struct Header {
    pub major: u16,
    pub minor: u16,
    pub flags: u16,
    pub header_size: u16,
    pub content_hash: [u8; 32],
    pub dialect_hash: u64,
    pub total_size: u64,
    pub sections: [SectionSpan; 17],
}

Parsed fixed header.

Fields

major: u16

minor: u16

flags: u16

header_size: u16

content_hash: [u8; 32]

dialect_hash: u64

total_size: u64

sections: [SectionSpan; 17]

Implementations

impl Header

pub fn span(&self, section: Section) -> SectionSpan

pub fn span_mut(&mut self, section: Section) -> &mut SectionSpan

pub fn parse(buf: &[u8]) -> Result<Header>

Parse and structurally check the fixed header.

This checks the prefix, versions and flags only. Section ranges are validated by crate::validate::validate, which owns the full invariants.

pub fn try_write(&self, out: &mut [u8]) -> Result<()>

Serialize this header, returning an error when out is too short.

Prefer this over Header::write in code that accepts a caller-owned buffer: the failure is a value, not a panic.

pub fn write(&self, out: &mut [u8])

Serialize this header into the first HEADER_SIZE bytes of out.

Panics

Panics when out is shorter than HEADER_SIZE. Use Header::try_write for a fallible form.

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 Copy for Header

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