Skip to main content

PackOptions

Struct PackOptions 

Source
pub struct PackOptions {
Show 22 fields pub chunk: ChunkParams, pub block_size: u32, pub level: i32, pub codec: CodecChoice, pub effort: u8, pub train_dict: bool, pub dict_size: usize, pub dict_warmup: usize, pub container_aware: bool, pub password: Option<String>, pub kdf: KdfParams, pub sign_seed: Option<[u8; 32]>, pub keep_mtime: bool, pub timestamp: bool, pub profile: String, pub limits: Limits, pub batch: usize, pub references: Vec<PathBuf>, pub recipients: Vec<Recipient>, pub canonical: bool, pub delta: bool, pub jpeg_recompression: bool,
}

Fields§

§chunk: ChunkParams§block_size: u32

0 = granular (one chunk per blob, best random access); otherwise consecutive unique chunks are compressed together in blocks of up to this many bytes (default 1 MiB).

§level: i32§codec: CodecChoice

Codec(s) the packer may use per block.

§effort: u8

Codec-choice effort for CodecChoice::Best, 1..=5 (codec::CodecOptions::effort): 1 = zstd only, 2 = zstd or xz decided on a sample of each block, 3 = zstd, xz or PPMd decided on a sample, 4 = 3 plus an xz check when PPMd wins, 5 = every codec on every block (default). Blocks of at most 128 KiB always run the full trial. Not recorded in the archive.

§train_dict: bool

Train a zstd dictionary on the first dict_warmup bytes of unique chunks (granular mode only).

§dict_size: usize§dict_warmup: usize§container_aware: bool§password: Option<String>§kdf: KdfParams§sign_seed: Option<[u8; 32]>§keep_mtime: bool§timestamp: bool§profile: String§limits: Limits§batch: usize

Blocks compressed in parallel per batch (0 = number of CPU threads).

§references: Vec<PathBuf>

Reference archives: chunks already present in them are referenced, not stored.

§recipients: Vec<Recipient>

Hybrid X25519 + ML-KEM-768 recipients (public key bytes); each gets its own stanza.

§canonical: bool

Also store canonical views (DOCX -> Markdown, PDF -> text) as derived entries under .tsaur/views/ (hybrid fidelity: originals stay bit-exact, views are pre-computed).

§delta: bool

Delta coding: blocks of an entry that looks like a new version of an earlier entry (same path in a reference archive, or a similarly named earlier entry of this archive) are also tried with zstd against that earlier content as dictionary; the smaller encoding wins.

§jpeg_recompression: bool

Recompress JPEG files and PDF DCTDecode images with Lepton when the build has it. false (pack --no-lepton) stores them as they are, so that every build, including one without the lepton feature, can read the archive.

Trait Implementations§

Source§

impl Clone for PackOptions

Source§

fn clone(&self) -> Self

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 Debug for PackOptions

Source§

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

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

impl Default for PackOptions

Source§

fn default() -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DefaultBoxed for T
where T: Default,

Source§

unsafe fn default_in_place(ptr: *mut T)

Fill the given memory location with default value. Read more
Source§

fn default_boxed() -> Box<Self>
where Self: Sized,

Create a boxed instance with default value for each field.
Source§

fn default_boxed_array<const N: usize>() -> Box<[Self; N]>
where Self: Sized,

Create a boxed array of the given size with default value of the type. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.