Struct Book 

pub struct Book {
    pub metadata: Metadata,
    pub sections: Vec<Section>,
}

The root of the content tree: one book.

Fields

metadata: Metadata

The work’s title, author and frontend extensions.

sections: Vec<Section>

The chapters/files, in reading order.

Implementations

impl Book

pub fn anchors(&self) -> Anchors

What the links in this book can reach.

Read it after Book::assign_node_ids, because the nodes it gives are the ids that numbering assigns.

impl Book

pub fn assign_node_ids(&mut self)

Assign ids to every node, in document order (pre-order: a node before its children, sections in reading order), starting at 1. Runs once, after deserialization; running it again renumbers.

pub fn node_at(&self, source: &str, byte: u32) -> Option<NodeId>

The node one byte of one source was read into: the innermost, so a byte of prose answers with the run it was typed into and a byte of markup answers with the construct it opens.

Only sections read from that source are looked at, so one file’s cursor is answered by one file’s nodes. Nothing for a byte no node was read from, such as a blank line between chapters or a source’s frontmatter, and nothing for a tree built rather than parsed.

pub fn source_of(&self, node: NodeId) -> Option<(&str, SourceSpan)>

The source a node was read from, and the bytes of it the node covers.

Nothing for a node the engine synthesized, or one from a tree built rather than parsed: neither was read from anything.

pub fn names(&self, source: Option<&str>) -> Names

The classes and the ids the blocks and inlines of one source carry, or of every source when source is None. A list item, a table row or cell, and a note count as blocks and inlines here.

A section’s own names are not in the answer. A host sets them beside the source, or frontmatter writes them.

pub fn subtree(&self, node: NodeId) -> Option<Range<u32>>

The ids one node and its descendants hold.

Ids are assigned in document order, a node before its children, so what a node covers is a run of consecutive numbers. Asking what a node was set from is asking about every id in this range.

Nothing for a node the book does not hold.

Trait Implementations

impl Clone for Book

fn clone(&self) -> Book

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 Default for Book

fn default() -> Book

Returns the “default value” for a type.

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: &Book) -> 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