Struct BlockHeader 

pub struct BlockHeader {
    pub last_block: bool,
    pub block_type: BlockType,
    pub block_size: usize,
}

Parsed block header.

Fields

last_block: bool

Whether this is the last block in the frame.

block_type: BlockType

Block type.

block_size: usize

Block size in bytes. For Raw: size of uncompressed data For RLE: decompressed size (compressed is 1 byte) For Compressed: size of compressed data

Implementations

impl BlockHeader

pub const SIZE: usize = 3

Block header size in bytes.

pub const MAX_BLOCK_SIZE: usize

Maximum block size (128 KB - 1).

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

Parse a block header from 3 bytes.

Byte 0-2 (little-endian):
  Bit 0:     Last_Block flag
  Bits 1-2:  Block_Type
  Bits 3-23: Block_Size (21 bits)

pub fn compressed_size(&self) -> usize

Get the size of compressed data to read. For RLE blocks, this is 1 (the byte to repeat).

pub fn decompressed_size(&self) -> usize

Get the size of decompressed output.

Trait Implementations

impl Clone for BlockHeader

fn clone(&self) -> BlockHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockHeader

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

Formats the value using the given formatter.

impl PartialEq for BlockHeader

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

impl Eq for BlockHeader

impl StructuralPartialEq for BlockHeader