Struct FrameHeader 

pub struct FrameHeader {
    pub window_size: u64,
    pub content_size: Option<u64>,
    pub dict_id: u32,
    pub checksum: bool,
    pub single_segment: bool,
    pub header_len: usize,
}

A parsed frame header.

Fields

window_size: u64

Window size in bytes (equal to the content size for single-segment frames).

content_size: Option<u64>

Declared decompressed size, if recorded.

dict_id: u32

0 when the frame names no dictionary.

checksum: bool

A 4-byte XXH64-based checksum follows the last block.

single_segment: bool

No window descriptor: the window is the whole content.

header_len: usize

Bytes from the magic number through the end of the header.

Implementations

impl FrameHeader

pub fn parse(src: &[u8]) -> Result<FrameHeader>

Parses the header of a zstd frame starting at src[0] (the magic number).

pub fn parse_format(src: &[u8], format: FrameFormat) -> Result<FrameHeader>

Parses a frame header in the given format.

pub fn write(&self, window_log: u32, out: &mut Vec<u8>)

Appends this header (magic included). window_log is used when not single-segment.

pub fn write_format( &self, format: FrameFormat, window_log: u32, out: &mut Vec<u8>, )

Appends this header in the given format.

Trait Implementations

impl Clone for FrameHeader

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 FrameHeader

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl Eq for FrameHeader

impl PartialEq for FrameHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameHeader