Skip to main content

SpineBuilder

Struct SpineBuilder 

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

Spine builder for EPUB reading order

The SpineBuilder is responsible for managing the spine items in an EPUB publication. The spine defines the default reading order of the publication - the sequence in which the reading system should present the content documents to the reader.

Each spine item references a manifest item by its ID (idref), indicating which resource should be displayed at that point in the reading order.

Implementations§

Source§

impl SpineBuilder

Source

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

Add a spine item

Appends a new spine item to the builder, defining the next position in the reading order.

§Parameters
  • item: The spine item to add
§Return
  • &mut Self: Returns a mutable reference to itself for method chaining
Source

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

Clear all spine items

Removes all spine items from the builder.

Trait Implementations§

Source§

impl Debug for SpineBuilder

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.