Struct FrameHeader 

pub struct FrameHeader {
    pub descriptor: FrameDescriptor,
    pub window_size: usize,
    pub dictionary_id: u32,
    pub frame_content_size: Option<u64>,
    pub has_checksum: bool,
    pub header_size: usize,
}

Parsed Zstd frame header.

Fields

descriptor: FrameDescriptor

Frame descriptor.

window_size: usize

Window size in bytes.

dictionary_id: u32

Dictionary ID (0 if not present).

frame_content_size: Option<u64>

Frame content size (None if not present).

has_checksum: bool

Whether content checksum is present.

header_size: usize

Total header size in bytes (including magic number).

Implementations

impl FrameHeader

pub fn parse(data: &[u8]) -> Result<Self>

Parse a frame header from the input buffer.

The buffer should start at the frame descriptor (after magic number).

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl PartialEq for FrameHeader

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

impl StructuralPartialEq for FrameHeader