Struct EpubOptions 

#[non_exhaustive]
pub struct EpubOptions {
    pub cover_image: Option<(String, Vec<u8>)>,
    pub fonts: Vec<(String, Vec<u8>)>,
    pub stylesheets: Vec<String>,
    pub metadata_xml: Option<String>,
    pub subdirectory: Option<String>,
    pub split_level: Option<usize>,
    pub source_date_epoch: Option<i64>,
    pub locale: Option<String>,
}

Options for the EPUB container writer. Ignored by every other writer. The default is an empty book: no cover, no embedded fonts, the built-in stylesheet only, and chapters split at the top heading level.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cover_image: Option<(String, Vec<u8>)>

A cover image as (file name, bytes). Produces a dedicated cover page and marks the image as the publication cover.

fonts: Vec<(String, Vec<u8>)>

Fonts to embed verbatim, each as (file name, bytes). A stylesheet refers to them by name.

stylesheets: Vec<String>

User stylesheet contents, linked from every page. When any are given they replace the built-in stylesheet entirely; several are linked in order. Empty leaves the built-in in place.

metadata_xml: Option<String>

A Dublin Core metadata fragment (bare <dc:*> elements) merged into the package metadata.

subdirectory: Option<String>

The container directory holding all publication content. None uses the conventional EPUB; an empty string places the content at the archive root.

split_level: Option<usize>

The heading level at which the book is split into separate chapter files. None splits at the top level, so each level-one heading starts a new file.

source_date_epoch: Option<i64>

Seconds since the Unix epoch fixing the publication’s modification timestamp. None uses a fixed epoch so output stays byte-reproducible.

locale: Option<String>

The process locale (the LANG environment variable) whose language tag stands in when the document names no lang. None falls back to en-US, keeping output independent of the environment.

Trait Implementations

impl Clone for EpubOptions

fn clone(&self) -> EpubOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpubOptions

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

Formats the value using the given formatter.

impl Default for EpubOptions

fn default() -> EpubOptions

Returns the “default value” for a type.