Enum BufferPolicy 

#[non_exhaustive]
pub enum BufferPolicy {
    Window {
        window_bytes: usize,
    },
    Spool {
        max_bytes: usize,
    },
}

How a BufferedReadAt retains bytes from a sequential stream.

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.

Window

Retain only the most recent window_bytes. A read older than the window fails with SourceError::BeyondWindow. Right for AccessPattern::Sequential and small AccessPattern::BoundedBacktrack decoders.

Fields

window_bytes: usize

Bytes retained behind the read watermark.

Spool

Retain every byte consumed, up to max_bytes; more fails with SourceError::BeyondLimit. Right for AccessPattern::RandomAccess decoders, with the cap sized to the largest file the driver is willing to hold in memory.

Fields

max_bytes: usize

Maximum retained bytes.

Implementations

impl BufferPolicy

pub const fn for_pattern(pattern: AccessPattern, max_bytes: usize) -> Self

A compatibility heuristic that may clamp the required lookback. Use Self::try_for_pattern when the access pattern must be satisfied.

pub const fn try_for_pattern( pattern: AccessPattern, max_bytes: usize, ) -> Result<Self, SourceError>

Choose a policy whose retained history satisfies pattern within the cap.

A required backtrack window larger than the cap is refused, never clamped. A random-access stream can still exceed its spool cap at runtime. This caps retained payload, not total process memory or caller-owned output.

impl BufferPolicy

pub const fn max_bytes(&self) -> usize

Byte cap of this policy (window size or spool limit).

Trait Implementations

impl Clone for BufferPolicy

fn clone(&self) -> BufferPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BufferPolicy

impl Debug for BufferPolicy

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

Formats the value using the given formatter.

impl Eq for BufferPolicy

impl PartialEq for BufferPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BufferPolicy