Struct bookbinder::BookSrc

pub struct BookSrc<'a> {
    pub metadata: Metadata<'a>,
    pub contents: Vec<BookEvent<'a>>,
    pub expected_appendices_count: usize,
    pub expected_epigraph_count: usize,
}

A processed book source ready to be rendered

Fields

metadata: Metadata<'a>

associated metadata of this book

contents: Vec<BookEvent<'a>>

the events which make up this book

expected_appendices_count: usize

the number of appendices in this book

expected_epigraph_count: usize

the number of epigraphs to this work

Implementations

impl<'a> BookSrc<'a>

pub fn change_headers(&mut self, format: TextHeaderOptions)

Change chapter and part headers to be of the specified format

Trait Implementations

impl<'a> Clone for BookSrc<'a>

pub fn clone(&self) -> BookSrc<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BookSrc<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BookSrc<'a>

pub fn default() -> BookSrc<'a>

Returns the "default value" for a type.

impl<'_> EpubRenderer for BookSrc<'_>

pub fn render_to_epub(self, options: Options) -> Result<Vec<u8>, RenderingError>

render to an epub with the given options

fn render_to_epub_default(self) -> Result<Vec<u8>, RenderingError>

render to an epub with default options

impl<'_> TexRenderer for BookSrc<'_>

pub fn render_to_tex_with_options(self, options: PreambleOptions) -> String

Render with particular options to generate a preamble with

pub fn render_to_tex(self) -> String

Render with default options

pub fn render_to_tex_standalone(
    self,
    logo: Option<PathBuf>,
    include_toc: bool
) -> String

Render to tex with a pregenerated preamble

pub fn render_to_tex_with_preamble(
    self,
    options: OptionsWithRenderedPreamble
) -> String

Render to a fragment of tex without a preamble or document beginning or end

impl<'a> TryFrom<DeserializableBookSrc<'a>> for BookSrc<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(src: DeserializableBookSrc<'a>) -> Result<Self, Self::Error>

Performs the conversion.