Struct NavigationGuide

pub struct NavigationGuide {
    pub items: Vec<NavigationGuideLine>,
    pub prologue: Option<String>,
    pub epilogue: Option<String>,
}

Represents a complete navigation guide

Fields

items: Vec<NavigationGuideLine>

The root items in the guide

prologue: Option<String>

The original prologue content (before the guide block)

epilogue: Option<String>

The original epilogue content (after the guide block)

Implementations

impl NavigationGuide

pub fn new() -> Self

Create a new empty navigation guide

pub fn get_full_path(&self, item: &NavigationGuideLine) -> PathBuf

Get the full path for an item by traversing up the hierarchy

Trait Implementations

impl Clone for NavigationGuide

fn clone(&self) -> NavigationGuide

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavigationGuide

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

Formats the value using the given formatter.

impl Default for NavigationGuide

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NavigationGuide

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NavigationGuide

fn eq(&self, other: &NavigationGuide) -> 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 Serialize for NavigationGuide

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NavigationGuide

impl StructuralPartialEq for NavigationGuide