Struct PackWriteOptions 

pub struct PackWriteOptions {
    pub window: usize,
    pub depth: usize,
    pub prefer_ofs_delta: bool,
    pub thin_bases: HashMap<ObjectId, EncodedObject>,
    pub reorder: bool,
}

Options controlling sliding-window delta selection during pack generation.

Construct with PackWriteOptions::new (sensible defaults) and adjust with the builder-style setters, or build one directly. Used by PackFile::write_packed_with_options and PackFile::write_thin.

Fields

window: usize

Number of previous same-type candidates each object is deltified against. Larger windows find better deltas at higher cost.

depth: usize

Maximum delta chain depth. A value of 0 disables deltification.

prefer_ofs_delta: bool

When true, in-pack deltas are encoded as ofs-deltas (the default and git’s preference). When false, in-pack deltas use ref-deltas. Deltas against external thin-pack bases always use ref-deltas regardless.

thin_bases: HashMap<ObjectId, EncodedObject>

External base objects, keyed by object id, that are not written into the pack but may be used as delta bases. Supplying any entries here produces a thin pack (see PackFile::write_thin). Empty by default, yielding a self-contained pack.

reorder: bool

When true (the default), objects are reordered by type and size for better delta locality. When false, the input order is preserved (the emitted pack lists objects in the order supplied); deltas then only reference earlier input objects. Reordering is always skipped when deltification is disabled (depth == 0), since it has no effect there.

Implementations

impl PackWriteOptions

pub fn new() -> Self

Options with git-compatible defaults: window DEFAULT_PACK_WINDOW, depth DEFAULT_PACK_DEPTH, ofs-deltas, and no external thin bases.

pub fn with_window(self, window: usize) -> Self

Set the sliding-window size.

pub fn with_depth(self, depth: usize) -> Self

Set the maximum delta chain depth (0 disables deltas).

pub fn with_prefer_ofs_delta(self, prefer_ofs_delta: bool) -> Self

Choose whether in-pack deltas use ofs-delta (true) or ref-delta (false) base references.

pub fn with_thin_bases( self, thin_bases: HashMap<ObjectId, EncodedObject>, ) -> Self

Provide the set of external base objects permitted for a thin pack.

pub fn with_reorder(self, reorder: bool) -> Self

Choose whether objects may be reordered for delta locality (true) or emitted in input order (false).

Trait Implementations

impl Clone for PackWriteOptions

fn clone(&self) -> PackWriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackWriteOptions

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

Formats the value using the given formatter.

impl Default for PackWriteOptions

fn default() -> Self

Returns the “default value” for a type.