Skip to main content

PackOptions

Struct PackOptions 

Source
pub struct PackOptions {
    pub lock: LockMode,
    pub indexes: bool,
    pub exclude_tables: Vec<String>,
    pub include: Vec<PackInclude>,
    pub encryption: Option<CipherOptions>,
    pub extra: Vec<(String, Vec<u8>)>,
    pub limits: PackLimits,
}

Fields§

§lock: LockMode

How the writer lock is taken for the length of the read. As in super::BackupOptions.

§indexes: bool

Also pack the <table>.idx snapshots (caches; off by default).

§exclude_tables: Vec<String>

Tables whose data is left out of the archive and its manifest — see super::BackupOptions::exclude_tables.

§include: Vec<PackInclude>

Further databases living in subfolders of the directory being packed (a Universe with its Projects, say), each with its own tables to leave out. They travel in the same archive under their folder name, each with a manifest of its own, and are unpacked together.

§encryption: Option<CipherOptions>

The keys of the packed directory’s database when it is encrypted. The pack carries its files sealed, exactly as they are on disk; the keys are only needed to read which files they are.

§extra: Vec<(String, Vec<u8>)>

Files of the caller’s own to store next to the database files (a manifest of the application’s format, say), as (name inside the archive, bytes). Read back with read_pack_entry.

§limits: PackLimits

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<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> 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.