Struct HeaderPrefix 

#[repr(C)]
pub struct HeaderPrefix {
    pub magic: [u8; 4],
    pub version: u32,
    pub remaining_header_bytes: u32,
}

FILE FORMAT PREFIX LAYOUT. THIS MUST NEVER CHANGE The prefix is part of the on-disk binary format and is used for streaming / incremental parsing. If you modify the fields, their types, ordering, or size, all previously written files will become unreadable.

If format updates are needed, bump version instead and evolve the rest of the header format conditionally.

Fields

magic: [u8; 4]

version: u32

remaining_header_bytes: u32

Implementations

impl HeaderPrefix

pub fn new() -> Self

pub fn length() -> usize

pub fn write_all(&self, cursor: &mut Cursor<&mut [u8]>) -> Result<(), Error>

pub fn parse(buffer: &[u8]) -> Result<(Option<HeaderPrefix>, usize), Error>

Trait Implementations

impl Clone for HeaderPrefix

fn clone(&self) -> HeaderPrefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderPrefix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HeaderPrefix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HeaderPrefix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.