Struct NavPoint 

pub struct NavPoint {
    pub label: String,
    pub content: Option<PathBuf>,
    pub children: Vec<NavPoint>,
    pub play_order: Option<usize>,
}

Represents a navigation point in an EPUB document’s table of contents

The NavPoint structure represents a single entry in the hierarchical table of contents of an EPUB publication. Each navigation point corresponds to a section or chapter in the publication and may contain nested child navigation points to represent sub-sections.

Builder Methods

When the builder feature is enabled, this struct provides convenient builder methods:

use lib_epub::types::NavPoint;

let nav_point = NavPoint::new("Chapter 1")
    .with_content("chapter1.xhtml")
    .append_child(
        NavPoint::new("Section 1.1")
            .with_content("section1_1.xhtml")
            .build()
    )
    .build();

Fields

label: String

The display label/title of this navigation point

This is the text that should be displayed to users in the table of contents.

content: Option<PathBuf>

The content document path this navigation point references

Can be None for navigation points that no relevant information was provided in the original data.

children: Vec<NavPoint>

Child navigation points (sub-sections)

play_order: Option<usize>

The reading order position of this navigation point

It can be None for navigation points that no relevant information was provided in the original data.

Implementations

impl NavPoint

pub fn new(label: &str) -> Self

Creates a new navigation point with the given label

Requires the builder feature.

Parameters

• label - The display label for this navigation point

pub fn with_content(&mut self, content: &str) -> &mut Self

Sets the content path for this navigation point

Requires the builder feature.

Parameters

• content - The path to the content document

pub fn append_child(&mut self, child: NavPoint) -> &mut Self

Appends a child navigation point

Requires the builder feature.

Parameters

• child - The child navigation point to add

pub fn set_children(&mut self, children: Vec<NavPoint>) -> &mut Self

Sets all child navigation points

Requires the builder feature.

Parameters

• children - Vector of child navigation points

pub fn build(&self) -> Self

Builds the final navigation point

Requires the builder feature.

Trait Implementations

impl Clone for NavPoint

fn clone(&self) -> NavPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavPoint

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

Formats the value using the given formatter.

impl Ord for NavPoint

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NavPoint

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NavPoint

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for NavPoint