Struct FrameDescriptor 

pub struct FrameDescriptor { /* private fields */ }

Frame header descriptor byte.

Bit 7-6: Frame_Content_Size_flag
Bit 5:   Single_Segment_flag
Bit 4:   Unused_bit (must be 0)
Bit 3:   Reserved_bit (must be 0)
Bit 2:   Content_Checksum_flag
Bit 1-0: Dictionary_ID_flag

Implementations

impl FrameDescriptor

pub fn new(byte: u8) -> Result<Self>

Parse a frame descriptor from a byte.

pub fn frame_content_size_flag(&self) -> u8

Get the Frame_Content_Size_flag (bits 7-6). Returns the number of bytes used for frame content size: 0 = 0 bytes, 1 = 1 byte, 2 = 2 bytes, 3 = 8 bytes

pub fn frame_content_size_bytes(&self) -> usize

Get the number of bytes for the frame content size field.

pub fn single_segment_flag(&self) -> bool

Get the Single_Segment_flag (bit 5). When set, window size is derived from frame content size.

pub fn content_checksum_flag(&self) -> bool

Get the Content_Checksum_flag (bit 2). When set, a 4-byte XXHash64 checksum follows the last block.

pub fn dictionary_id_flag(&self) -> u8

Get the Dictionary_ID_flag (bits 1-0). Returns the number of bytes for dictionary ID: 0, 1, 2, or 4.

pub fn dictionary_id_bytes(&self) -> usize

Get the number of bytes for the dictionary ID field.

pub fn has_window_descriptor(&self) -> bool

Whether this frame requires a window descriptor byte.

Trait Implementations

impl Clone for FrameDescriptor

fn clone(&self) -> FrameDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDescriptor

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

Formats the value using the given formatter.

impl PartialEq for FrameDescriptor

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

impl Eq for FrameDescriptor

impl StructuralPartialEq for FrameDescriptor