Skip to main content

PackWriteLimits

Struct PackWriteLimits 

Source
pub struct PackWriteLimits {
    pub compression_working_set: ByteBudget,
    pub decoded_object: ByteBudget,
    pub delta_base: ByteBudget,
}
Expand description

Memory budgets for streaming pack generation.

Compression windows are admitted by these byte budgets, not by a fixed object count. A single object larger than Self::compression_working_set but within Self::decoded_object is written as an explicit one-object quantum. A single retained delta base may likewise exceed Self::delta_base and is kept alone. Either case is documented by the resulting working-set high-water mark; nothing else may silently exceed the configured budgets.

Peak charged memory is at most compression_working_set + delta_base plus one leftover lookahead object that did not fit the current window, and one oversized one-object quantum or retained base. The leftover is charged so decoded RAM cannot silently approach twice the working-set budget. Zlib output buffers and allocator slack are not included.

Fields§

§compression_working_set: ByteBudget

Decoded bodies plus per-object overhead admitted into one compression quantum.

§decoded_object: ByteBudget

Hard cap on one decoded object body. Exceeding this is a typed limit error; the object is not treated as a one-object quantum.

§delta_base: ByteBudget

Retained sliding-window delta-base bodies. Charged separately from the compression working set.

Implementations§

Source§

impl PackWriteLimits

Source

pub fn new() -> Self

Fail-closed defaults: 32 MiB compression working set, 512 MiB single decoded object, 32 MiB retained delta bases.

Source

pub fn with_compression_working_set(self, budget: ByteBudget) -> Self

Source

pub fn with_decoded_object(self, budget: ByteBudget) -> Self

Source

pub fn with_delta_base(self, budget: ByteBudget) -> Self

Trait Implementations§

Source§

impl Clone for PackWriteLimits

Source§

fn clone(&self) -> PackWriteLimits

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PackWriteLimits

Source§

impl Debug for PackWriteLimits

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PackWriteLimits

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for PackWriteLimits

Source§

impl PartialEq for PackWriteLimits

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PackWriteLimits

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.