Struct WorkBudget 

pub struct WorkBudget { /* private fields */ }

Available on crate feature caller-workspace only.

Work a caller allows its decode steps, in units charged before the work they pay for runs.

One unit is charged per input byte consumed (frame and block headers, block contents, skippable frames, checksums), and one per byte a block may produce, before it is produced: a Raw block’s bytes as each part of it is copied, an RLE block’s stated size, and a compressed block’s frame block maximum plus COMPRESSED_BLOCK_UNITS for its table builds. A charge the budget cannot cover refuses the step before that work starts.

Implementations

impl WorkBudget

pub const fn new(units: u64) -> Self

A budget of units.

pub const fn remaining(&self) -> u64

Units still available.

pub fn add(&mut self, units: u64)

Add units to the budget, stopping at u64::MAX, which is already more work than any stream can ask for.

Trait Implementations

impl Clone for WorkBudget

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 WorkBudget

impl Debug for WorkBudget

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

Formats the value using the given formatter.

impl Eq for WorkBudget

impl PartialEq for WorkBudget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkBudget