Skip to main content

SaveOptions

Struct SaveOptions 

Source
pub struct SaveOptions {
    pub mode: SaveMode,
    pub version: Version,
    pub object_streams: bool,
    pub compress: bool,
    pub encryption: Option<Encryption>,
    pub document_id: Option<[u8; 16]>,
    pub entropy: Option<Arc<dyn Entropy>>,
}
Expand description

Options for Document::save.

Fields§

§mode: SaveMode

Full rewrite or incremental append.

§version: Version

Output version for a full save (1.7 by default, or 2.0). An incremental save keeps the original header.

§object_streams: bool

Pack non-stream objects into object streams with an xref stream (full save). Without it, a classic xref table is written.

§compress: bool

Flate-compress streams that have no filter.

§encryption: Option<Encryption>

Encrypt the output (full save only).

§document_id: Option<[u8; 16]>

The document ID to write; by default it is derived from the content.

§entropy: Option<Arc<dyn Entropy>>

Randomness for encryption keys, salts and IVs. Required whenever something is encrypted.

Trait Implementations§

Source§

impl Clone for SaveOptions

Source§

fn clone(&self) -> SaveOptions

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 SaveOptions

Source§

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

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

impl Default for SaveOptions

Source§

fn default() -> SaveOptions

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> ErasedDestructor for T
where T: 'static,

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.