Enum RetentionPolicy 

#[non_exhaustive]
pub enum RetentionPolicy {
    Aggressive,
    Bounded {
        max_bytes: usize,
    },
    ReleaseAll,
}

What a codec keeps allocated between operations.

Reuse is the point of a long-lived codec, so the default keeps every buffer. A caller compressing occasionally, or juggling many codecs, can trade that back for memory. The policy never changes the bytes produced.

Examples

use mzstd::{Compressor, RetentionPolicy};

let mut encoder = Compressor::new(Default::default())?;
encoder.compress(b"warm the tables up")?;
assert!(encoder.retained_bytes() > 0);
encoder.trim(RetentionPolicy::ReleaseAll);
assert_eq!(encoder.retained_bytes(), 0);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Aggressive

Keep every buffer.

Bounded

Keep buffers while they fit inside a ceiling, and release them when not.

Fields

max_bytes: usize

The most the codec may retain, in bytes.

ReleaseAll

Keep nothing between operations.

Trait Implementations

impl Clone for RetentionPolicy

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 RetentionPolicy

impl Debug for RetentionPolicy

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

Formats the value using the given formatter.

impl Default for RetentionPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RetentionPolicy

impl Hash for RetentionPolicy

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 RetentionPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RetentionPolicy