Struct Book 

pub struct Book {
    pub format_version: u32,
    pub metadata: Metadata,
    pub sections: Vec<Section>,
    pub style: StyleSettings,
    pub extra: Extra,
}

A whole book as imported and edited by the author.

Fields

format_version: u32

metadata: Metadata

sections: Vec<Section>

Front matter, body and back matter in reading order.

style: StyleSettings

extra: Extra

Implementations

impl Book

pub fn new(metadata: Metadata) -> Self

pub fn chapters(&self) -> impl Iterator<Item = &Section>

Body chapters only (what gets numbered).

pub fn section_numbers(&self) -> Vec<Option<SectionNumber>>

The number of each section, by index: chapters and parts are counted apart, Auto counts on from the last one of its kind, Explicit(n) is n and the count goes on from it. Other kinds and Numbering::None have none. Print, EPUB, pre-flight and the app all number from this.

pub fn block(&self, at: BlockRef) -> Option<&Block>

pub fn block_mut(&mut self, at: BlockRef) -> Option<&mut Block>

Trait Implementations

impl Clone for Book

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Book

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Book

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Book

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Book

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Book