Struct DecompressionBudget 

pub struct DecompressionBudget(/* private fields */);

Upper bound on the bytes verify decodes to check payload integrity.

The budget bounds the work done beyond what listing already does: ZIP entries and 7z blocks are charged their declared uncompressed size before they are decoded, and for compressed TAR it bounds the read from the end marker to decoder EOF. TAR entry content is never charged because listing decodes it anyway. The default is a fixed 500 MiB, equal to the default max_total_size; it does not follow a raised max_total_size.

Examples

use exarch_core::DecompressionBudget;

assert!(DecompressionBudget::try_from_bytes(0).is_err());
let budget = DecompressionBudget::try_from_bytes(1024)?;
assert_eq!(budget.get(), 1024);
assert_eq!(DecompressionBudget::default(), DecompressionBudget::DEFAULT);

Implementations

impl DecompressionBudget

pub const DEFAULT: Self

The default budget: 500 MiB.

pub const fn new(bytes: NonZeroU64) -> Self

Creates a budget from a non-zero byte count.

pub fn try_from_bytes(bytes: u64) -> Result<Self>

Creates a budget from a byte count.

Errors

Returns ArchiveError::InvalidConfiguration when bytes is zero.

pub const fn get(self) -> u64

Returns the budget in bytes.

Trait Implementations

impl Clone for DecompressionBudget

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 DecompressionBudget

impl Debug for DecompressionBudget

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

Formats the value using the given formatter.

impl Default for DecompressionBudget

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DecompressionBudget

impl Hash for DecompressionBudget

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 DecompressionBudget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecompressionBudget