Skip to main content

TocEntry

Struct TocEntry 

Source
pub struct TocEntry {
    pub label: String,
    pub href: String,
    pub children: Vec<TocEntry>,
}
Expand description

An entry in the EPUB table of contents.

EPUB navigation uses NCX (Navigation Control for XML) files which define a hierarchical structure of navigation points. Each entry can have child entries, creating a tree structure.

§Example

use epub_parser::TocEntry;

let mut toc_entry = TocEntry::new("Chapter 1".to_string(), "chapter1.xhtml".to_string());
toc_entry.children.push(TocEntry::new(
    "Section 1.1".to_string(),
    "chapter1.xhtml#section1".to_string()
));

println!("Entry: {} -> {}", toc_entry.label, toc_entry.href);
for child in &toc_entry.children {
    println!("  Child: {} -> {}", child.label, child.href);
}

Fields§

§label: String

The display label or title for this navigation point.

This is the text that would be shown in a table of contents.

§href: String

The target URL for this navigation point.

This is a relative path within the EPUB, often with an anchor (e.g., “chapter1.xhtml” or “chapter1.xhtml#section1”).

§children: Vec<TocEntry>

Child navigation entries.

The NCX format supports hierarchical navigation, so each entry can have nested sub-entries.

Implementations§

Source§

impl TocEntry

Source

pub fn new(label: String, href: String) -> Self

Creates a new TOC entry with the given label and href.

The children vector is initialized as empty.

§Arguments
  • label - The display text for this entry.
  • href - The target URL/path for this entry.
§Returns

A new TocEntry instance with empty children.

§Example
use epub_parser::TocEntry;

let entry = TocEntry::new("Introduction".to_string(), "intro.xhtml".to_string());
assert_eq!(entry.label, "Introduction");
assert_eq!(entry.href, "intro.xhtml");
assert!(entry.children.is_empty());

Trait Implementations§

Source§

impl Clone for TocEntry

Source§

fn clone(&self) -> TocEntry

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TocEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TocEntry

Source§

fn default() -> TocEntry

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.