Skip to main content

RootfileBuilder

Struct RootfileBuilder 

Source
pub struct RootfileBuilder { /* private fields */ }
Expand description

Rootfile builder for EPUB container

The RootfileBuilder is responsible for managing the rootfile paths in the EPUB container. Each rootfile points to an OPF (Open Packaging Format) file that defines the structure and content of an EPUB publication.

In EPUB 3.0, a single rootfile is typically used, but the structure supports multiple rootfiles for more complex publications.

§Notes

  • Rootfile paths must be relative and cannot start with “../” or “/”
  • At least one rootfile must be added before building the EPUB

Implementations§

Source§

impl RootfileBuilder

Source

pub fn add(&mut self, rootfile: impl AsRef<str>) -> Result<&mut Self, EpubError>

Add a rootfile path

Adds a new rootfile path to the builder. The rootfile points to the OPF file that will be created when building the EPUB.

§Parameters
  • rootfile: The relative path to the OPF file
§Return
  • Ok(&mut Self): Successfully added the rootfile
  • Err(EpubError): Error if the path is invalid (starts with “/” or “../”)
Source

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

Clear all rootfiles

Removes all rootfile paths from the builder.

Trait Implementations§

Source§

impl Debug for RootfileBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.