Struct CatalogBuilder 

pub struct CatalogBuilder { /* private fields */ }

Catalog builder for EPUB navigation

The CatalogBuilder is responsible for building the navigation document (TOC) of an EPUB publication. The navigation document provides a hierarchical table of contents that allows readers to navigate through the publication’s content.

The navigation document is a special XHTML document that uses the EPUB Navigation Document specification.

Implementations

impl CatalogBuilder

pub fn set_title(&mut self, title: impl Into<String>) -> &mut Self

Set the catalog title

Sets the title that will be displayed at the top of the navigation document.

Parameters

• title: The title to set

Return

• &mut Self: Returns a mutable reference to itself for method chaining

pub fn add(&mut self, item: NavPoint) -> &mut Self

Add a navigation point

Appends a new navigation point to the catalog. Navigation points can be nested by using the append_child method on NavPoint.

Parameters

• item: The navigation point to add

Return

• &mut Self: Returns a mutable reference to itself for method chaining

pub fn clear(&mut self) -> &mut Self

Clear all catalog items

Removes the title and all navigation points from the builder.

Trait Implementations

impl Debug for CatalogBuilder

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

Formats the value using the given formatter.