Struct StoredWindow 

pub struct StoredWindow { /* private fields */ }

Predecessor history for a checkpoint.

An empty window means no history is required: the start of the source, a member boundary, or an independent BGZF block. A non-empty window is exactly WINDOW_SIZE bytes of decompressed history, held either raw or zlib-compressed to bound resident memory.

Implementations

impl StoredWindow

pub const fn empty() -> Self

Returns a window carrying no history.

pub fn from_raw(bytes: impl Into<Vec<u8>>) -> Result<Self, IndexError>

Stores exactly one raw DEFLATE history window.

Errors

Returns IndexError::InvalidWindowSize unless bytes contains exactly WINDOW_SIZE bytes.

pub const fn is_empty(&self) -> bool

Returns whether this window carries no history.

pub const fn stored_len(&self) -> usize

Returns the number of bytes currently held, compressed or not.

pub const fn is_compressed(&self) -> bool

Returns whether the payload is held zlib-compressed.

pub fn from_raw_maybe_compress( bytes: impl Into<Vec<u8>>, compress: bool, ) -> Result<Self, IndexError>

Stores bytes, optionally zlib-compressed to reduce resident memory.

History that does not shrink is stored raw. The input must contain exactly WINDOW_SIZE bytes.

pub fn decompressed(&self) -> Result<Cow<'_, [u8]>, IndexError>

Returns the window history, expanding it when it is held compressed.

Trait Implementations

impl Clone for StoredWindow

fn clone(&self) -> StoredWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoredWindow

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

Formats the value using the given formatter.

impl Eq for StoredWindow

impl PartialEq for StoredWindow

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StoredWindow