[−][src]Struct bookbinder_epub::Options

pub struct Options {
    pub css: Option<PathBuf>,
    pub cover_image: Option<PathBuf>,
    pub titlepage: Option<PathBuf>,
    pub publisher_imprint_logo: Option<PathBuf>,
    pub titlepage_typeface: Option<Cow<'static, str>>,
    pub header_options: TextHeaderOptions,
    pub chapter_label: Option<Cow<'static, str>>,
}

Options for rendering as an epub

Fields

css: Option<PathBuf>

Custom css

cover_image: Option<PathBuf>

A cover image to use

titlepage: Option<PathBuf>

A titlepage image to use

publisher_imprint_logo: Option<PathBuf>

A publisher logo to use while generating the titlepage

titlepage_typeface: Option<Cow<'static, str>>

A typeface to use while generating the titlepage

header_options: TextHeaderOptions

The format of headers

chapter_label: Option<Cow<'static, str>>

A new label for chapters -- e.g. Letter 1 instead of Chapter 1

Implementations

`impl Options`[src]

`pub fn css<P: Into<PathBuf>>(&mut self, css: P) -> &mut Self`[src]

Set custom css to use

`pub fn set_chapter_label<S: Into<Cow<'static, str>>>( &mut self, label: S ) -> &mut Self`[src]

Set a custom label to use for chapters instead of Chapter

`pub fn cover_image<P: Into<PathBuf>>(&mut self, cover_image: P) -> &mut Self`[src]

Set a cover image

`pub fn titlepage<P: Into<PathBuf>>(&mut self, titlepage_image: P) -> &mut Self`[src]

Set a titlepage image to use instead of generating one

`pub fn publisher_imprint_logo<P: Into<PathBuf>>(&mut self, logo: P) -> &mut Self`[src]

Set a publisher logo to use when generating the titlepage

`pub fn titlepage_typeface<S: Into<Cow<'static, str>>>( &mut self, typeface: S ) -> &mut Self`[src]

Set the name of a typeface to use when generating the titlepage

`pub fn suppress_chapter_titles(&mut self) -> &mut Self`[src]

Do not show any given chapter's title -- rely instead on its label. For example, Chapter 1: Wolves Attack! would be represented as Chapter 1

`pub fn suppress_chapter_label(&mut self) -> &mut Self`[src]

Do not label chapters as such in headings; i.e. use only the chapter title. For example, Chapter 1: Wolves Attack! would be represented as Wolves Attack!

`pub fn only_number_chapters(&mut self) -> &mut Self`[src]

Indicate chapters only by using a numerical indication, in whatever format. For example, Chapter 1: Wolves Attack! would be represented as 1, or I if use_roman_numerals_for_chapter_labels was called

`pub fn use_roman_numerals_for_chapter_labels(&mut self) -> &mut Self`[src]

Label chapters with roman rather than arabic numerals: e.g. a third chapter would be labelled as Chapter III not Chapter 3

`pub fn use_words_for_chapter_labels(&mut self) -> &mut Self`[src]

Label chapters with words rather than numbers: e.g. a first chapter would be labelled as Chapter One not Chapter 1

Trait Implementations

`impl Clone for Options`[src]

`fn clone(&self) -> Options`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Options`[src]

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

`impl Default for Options`[src]

`fn default() -> Options`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Options`

`impl Send for Options`

`impl Sync for Options`

`impl Unpin for Options`

`impl UnwindSafe for Options`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Pointable for T`

`pub const ALIGN: usize`

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`

`pub unsafe fn drop(ptr: usize)`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct bookbinder_epub::Options

Fields

Implementations

impl Options[src]

pub fn css<P: Into<PathBuf>>(&mut self, css: P) -> &mut Self[src]

pub fn set_chapter_label<S: Into<Cow<'static, str>>>( &mut self, label: S) -> &mut Self[src]

pub fn cover_image<P: Into<PathBuf>>(&mut self, cover_image: P) -> &mut Self[src]

pub fn titlepage<P: Into<PathBuf>>(&mut self, titlepage_image: P) -> &mut Self[src]

pub fn publisher_imprint_logo<P: Into<PathBuf>>(&mut self, logo: P) -> &mut Self[src]

pub fn titlepage_typeface<S: Into<Cow<'static, str>>>( &mut self, typeface: S) -> &mut Self[src]

pub fn suppress_chapter_titles(&mut self) -> &mut Self[src]

pub fn suppress_chapter_label(&mut self) -> &mut Self[src]

pub fn only_number_chapters(&mut self) -> &mut Self[src]

pub fn use_roman_numerals_for_chapter_labels(&mut self) -> &mut Self[src]

pub fn use_words_for_chapter_labels(&mut self) -> &mut Self[src]

Trait Implementations

impl Clone for Options[src]

fn clone(&self) -> Options[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Options[src]

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

impl Default for Options[src]

fn default() -> Options[src]

Auto Trait Implementations

impl RefUnwindSafe for Options

impl Send for Options

impl Sync for Options

impl Unpin for Options

impl UnwindSafe for Options

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

pub fn to_owned(&self) -> T[src]

pub fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V