Struct EpubBuilder 

pub struct EpubBuilder<Version> { /* private fields */ }

EPUB Builder

The main structure used to create and build EPUB ebook files. Supports the EPUB 3.0 specification and can build a complete EPUB file structure.

Implementations

impl EpubBuilder<EpubVersion3>

pub fn new() -> Result<Self, EpubError>

Create a new EpubBuilder instance

Return

• Ok(EpubBuilder): Builder instance created successfully
• Err(EpubError): Error occurred during builder initialization

pub fn add_rootfile(&mut self, rootfile: &str) -> &mut Self

Add a rootfile path

The added path points to an OPF file that does not yet exist and will be created when building the Epub file.

Parameters

• rootfile: Rootfile path

pub fn add_metadata(&mut self, item: MetadataItem) -> &mut Self

Add metadata item

Required metadata includes title, language, and an identifier with ‘pub-id’. Missing this data will result in an error when building the epub file.

Parameters

• item: Metadata items to add

pub fn add_manifest( &mut self, manifest_source: &str, manifest_item: ManifestItem, ) -> Result<&mut Self, EpubError>

Add manifest item and corresponding resource file

The builder will automatically recognize the file type of the added resource and update it in ManifestItem.

Parameters

• manifest_source - Local resource file path
• manifest_item - Manifest item information

Return

• Ok(&mut Self) - Successful addition, returns a reference to itself
• Err(EpubError) - Error occurred during the addition process

pub fn add_spine(&mut self, item: SpineItem) -> &mut Self

Add spine item

The spine item defines the reading order of the book.

Parameters

• item: Spine item to add

pub fn set_catalog_title(&mut self, title: &str) -> &mut Self

Set catalog title

Parameters

• title: Catalog title

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

Add catalog item

Added directory items will be added to the end of the existing list.

Parameters

• item: Catalog item to add

pub fn set_catalog(&mut self, catalog: Vec<NavPoint>) -> &mut Self

Re-/ Set catalog

The passed list will overwrite existing data.

Parameters

• catalog: Catalog to set

pub fn make<P: AsRef<Path>>(self, output_path: P) -> Result<(), EpubError>

Builds an EPUB file and saves it to the specified path

Parameters

• output_path: Output file path

Return

• Ok(()): Build successful
• Err(EpubError): Error occurred during the build process

pub fn build<P: AsRef<Path>>( self, output_path: P, ) -> Result<EpubDoc<BufReader<File>>, EpubError>

Builds an EPUB file and returns a EpubDoc

Builds an EPUB file at the specified location and parses it into a usable EpubDoc object.

Parameters

• output_path: Output file path

Return

• Ok(EpubDoc): Build successful
• Err(EpubError): Error occurred during the build process

Trait Implementations

impl<Version> Drop for EpubBuilder<Version>

fn drop(&mut self)

Remove temporary directory when dropped