Struct StreamHeader 

pub struct StreamHeader {
    pub block_size: BlockSize,
}

Streaming frame header: the magic bytes and the block size.

The header is 9 bytes long. It records the requested block size verbatim. No clamp applies: short inputs still encode under the configured size. Blocks follow it until the input ends.

Examples

use bzip3_rs::{BlockSize, MAGIC_NUMBER, StreamHeader};

let header = StreamHeader::new(BlockSize::MIN);
let bytes = header.to_bytes();
assert_eq!(bytes.len(), StreamHeader::LEN);
assert!(bytes.starts_with(&MAGIC_NUMBER));
assert_eq!(StreamHeader::from_bytes(&bytes)?, header);

Fields

block_size: BlockSize

Largest original block size in the stream.

Implementations

impl StreamHeader

pub const LEN: usize = 9

Length of the header in bytes.

pub const fn new(block_size: BlockSize) -> Self

Build a header for block_size.

Examples

use bzip3_rs::{BlockSize, StreamHeader};

let header = StreamHeader::new(BlockSize::DEFAULT);
assert_eq!(header.block_size, BlockSize::DEFAULT);

pub const fn to_bytes(self) -> [u8; 9]

Encode the header into its 9 bytes.

The first 5 bytes are the magic number. The last 4 bytes are the block size as a little-endian integer.

Examples

use bzip3_rs::{BlockSize, StreamHeader};

let bytes = StreamHeader::new(BlockSize::MIN).to_bytes();
assert_eq!(&bytes[..5], b"BZ3v1");
assert_eq!(bytes[5..], BlockSize::MIN.get().to_le_bytes());

pub fn from_bytes(bytes: &[u8; 9]) -> Result<Self>

Parse the 9 header bytes.

Errors

Returns Error::InvalidMagic on bad magic, Error::InvalidBlockSize on a block size outside the valid range.

Examples

use bzip3_rs::error::Error;
use bzip3_rs::{BlockSize, StreamHeader};

let bytes = StreamHeader::new(BlockSize::MIN).to_bytes();
assert_eq!(StreamHeader::from_bytes(&bytes)?.block_size, BlockSize::MIN);

let bad = [0_u8; StreamHeader::LEN];
assert!(matches!(StreamHeader::from_bytes(&bad), Err(Error::InvalidMagic)));

Trait Implementations

impl Clone for StreamHeader

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 StreamHeader

impl Debug for StreamHeader

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

Formats the value using the given formatter.

impl Eq for StreamHeader

impl Hash for StreamHeader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamHeader