Struct bookbinder::deserialization::UnifiedOptions

pub struct UnifiedOptions {
    pub css: Option<PathBuf>,
    pub cover_image: Option<PathBuf>,
    pub titlepage: Option<PathBuf>,
    pub publisher_imprint_logo: Option<PathBuf>,
    pub titlepage_typeface: Option<String>,
    pub use_words_for_chapter_labels: bool,
    pub use_roman_numerals_for_chapter_labels: bool,
    pub suppress_chapter_labels: bool,
    pub suppress_chapter_titles: bool,
    pub only_number_chapters: bool,
    pub linespread: Option<f32>,
    pub open_any: bool,
    pub secnumdepth: Option<i32>,
    pub sans_typeface: Option<String>,
    pub serif_typeface: Option<String>,
    pub mono_typeface: Option<String>,
    pub headers_and_footers_typeface: Option<String>,
    pub heading_typeface: Option<String>,
    pub include_toc: bool,
    pub suppress_footers: bool,
    pub page_number_only_in_footers: bool,
    pub do_not_suppress_figure_labels: bool,
    pub ten_pt: bool,
    pub eleven_pt: bool,
    pub twelve_pt: bool,
    pub five_by_eight_inches: bool,
    pub five_twenty_five_by_eight_inches: bool,
    pub five_five_by_eight_five_inches: bool,
    pub six_by_nine_inches: bool,
    pub a4paper: bool,
    pub usletter: bool,
    pub uslegal: bool,
    pub chapter_label: Option<String>,
}

A representation of options which combines options across output formats; those which do not apply will be ignored.

Note that some flags are mutually contradictory. Check the source for the specific handling of such cases, but in general the smallest or the broadest option is chosen.

Fields

css: Option<PathBuf>

path to custom css for epub

cover_image: Option<PathBuf>

path to an epub cover image

titlepage: Option<PathBuf>

path to custom image for an epub titlepage

publisher_imprint_logo: Option<PathBuf>

path to publisher logo for use in generated titlepages

titlepage_typeface: Option<String>

name of the typeface to use in generated titlepages

use_words_for_chapter_labels: bool

flag to use words for chapter numbers

use_roman_numerals_for_chapter_labels: bool

flag to use roman numerals for chapter numbers

suppress_chapter_labels: bool

flag to suppress chapter labels

suppress_chapter_titles: bool

flag to suppress chapter titles

only_number_chapters: bool

flag to use chapter numbers only, rather than labels and titles

linespread: Option<f32>

linespread value for latex

open_any: bool

whether to set openany for latex

secnumdepth: Option<i32>

latex secnumdepth

sans_typeface: Option<String>

name of sans typeface to use in pdf output

serif_typeface: Option<String>

name of serif typeface to use in pdf output

mono_typeface: Option<String>

name of monospace typeface to use in pdf output

headers_and_footers_typeface: Option<String>

name of typeface to use for running headers and footers in pdf output

heading_typeface: Option<String>

name of typeface to use in pdf headings

include_toc: bool

flag to include a table of contents in pdf output

suppress_footers: bool

flag to suppress pdf footers

page_number_only_in_footers: bool

flag to include only page numbers in pdf footers

do_not_suppress_figure_labels: bool

flag to include figure labels in pdf output

ten_pt: bool

flag to set pdf font size to 10pt

eleven_pt: bool

flag to set pdf font size to 11pt

twelve_pt: bool

flag to set pdf font size to 12pt

five_by_eight_inches: bool

flag to set pdf papersize to 5x8 inches

five_twenty_five_by_eight_inches: bool

flag to set pdf papersize to 5'25"x8"

five_five_by_eight_five_inches: bool

flag to set pdf papersize to 5"x8'5"

six_by_nine_inches: bool

flag to set pdf papersize to 6"x9"

a4paper: bool

flag to set pdf papersize to A4

usletter: bool

flag to set pdf papersize to US Letter

uslegal: bool

flag to set pdf papersize to US Legal

chapter_label: Option<String>

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

Trait Implementations

impl Debug for UnifiedOptions

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

Formats the value using the given formatter.

impl Default for UnifiedOptions

fn default() -> UnifiedOptions

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for UnifiedOptions

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

Deserialize this value from the given Serde deserializer.

impl From<UnifiedOptions> for EpubOptions

fn from(src: UnifiedOptions) -> EpubOptions

Performs the conversion.

impl From<UnifiedOptions> for LatexOptions

fn from(src: UnifiedOptions) -> LatexOptions

Performs the conversion.