Skip to main content

EpubExportOptions

Struct EpubExportOptions 

Source
pub struct EpubExportOptions {
    pub title: String,
    pub author: String,
    pub language: String,
    pub rtl: bool,
}
Expand description

Book-level metadata for an EPUB export. Every field is required by the container format in some form, so unlike super::docx_options::DocxExportOptions there is no “no overrides” default that matches an unconfigured EPUB — Default instead picks the most reasonable placeholders.

Fields§

§title: String

Book title, used for the package’s dc:title and (when a chapter has no heading of its own — the front-matter chapter, or the whole document when it has no headings at all) as that chapter’s title too.

§author: String

Author name, used for the package’s dc:creator. Empty ⇒ no author is emitted.

§language: String

BCP-47/ISO 639-1 language code (e.g. "en", "fr"), used for the package’s dc:language and every chapter XHTML document’s xml:lang/lang. Empty ⇒ "en".

§rtl: bool

Right-to-left reading direction: sets the package’s page-progression-direction to rtl and adds dir="rtl" to every chapter’s <html> element.

Trait Implementations§

Source§

impl Clone for EpubExportOptions

Source§

fn clone(&self) -> EpubExportOptions

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 EpubExportOptions

Source§

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

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

impl Default for EpubExportOptions

Source§

fn default() -> EpubExportOptions

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

impl<'de> Deserialize<'de> for EpubExportOptions

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<EpubExportOptions, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EpubExportOptions

Source§

fn eq(&self, other: &EpubExportOptions) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for EpubExportOptions

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EpubExportOptions

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.