Skip to main content

CreateOptions

Struct CreateOptions 

Source
pub struct CreateOptions {
    pub title: Option<String>,
    pub mode: Option<Mode>,
    pub entry_point: Option<String>,
    pub manifest: Option<Manifest>,
    pub application: Option<Application>,
    pub when: Option<SystemTime>,
    pub keep_line_endings: bool,
    pub store_only: bool,
}
Expand description

Options for create.

Fields§

§title: Option<String>

Title. Defaults to the manifest’s, then the entry point’s first heading, then its file name.

§mode: Option<Mode>

Mode. Defaults to the manifest’s, then document.

§entry_point: Option<String>

Entry point. Defaults to the manifest’s, then discovery (Section 5.5).

§manifest: Option<Manifest>

Starting manifest: its fields are kept, with this library’s required fields set over them.

§application: Option<Application>

The application writing the archive.

§when: Option<SystemTime>

Timestamp for created, modified and the ZIP entries. Defaults to now.

§keep_line_endings: bool

Keep CRLF in Markdown files. By default Markdown files and the manifest get LF line endings; other files are always written as given (Section 12.2).

§store_only: bool

Store every file without compression.

Implementations§

Source§

impl CreateOptions

Source

pub fn new() -> Self

Default options.

Source

pub fn title(self, title: impl Into<String>) -> Self

Set the title.

Source

pub fn mode(self, mode: Mode) -> Self

Set the mode.

Source

pub fn entry_point(self, path: impl Into<String>) -> Self

Set the entry point.

Source

pub fn manifest(self, manifest: Manifest) -> Self

Set the starting manifest.

Source

pub fn application(self, application: Application) -> Self

Set the application.

Source

pub fn when(self, when: SystemTime) -> Self

Set the timestamp.

Source

pub fn keep_line_endings(self) -> Self

Keep CRLF line endings in Markdown files.

Source

pub fn store_only(self) -> Self

Store files without compression.

Trait Implementations§

Source§

impl Clone for CreateOptions

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 CreateOptions

Source§

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

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

impl Default for CreateOptions

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