Struct mdbook::book::Link

pub struct Link {
    pub name: String,
    pub location: Option<PathBuf>,
    pub number: Option<SectionNumber>,
    pub nested_items: Vec<SummaryItem>,
}

A struct representing an entry in the SUMMARY.md, possibly with nested entries.

This is roughly the equivalent of [Some section](./path/to/file.md).

Fields

name: String

The name of the chapter.

location: Option<PathBuf>

The location of the chapter’s source file, taking the book’s src directory as the root.

number: Option<SectionNumber>

The section number, if this chapter is in the numbered section.

nested_items: Vec<SummaryItem>

Any nested items this chapter may contain.

Implementations

impl Link

pub fn new<S: Into<String>, P: AsRef<Path>>(name: S, location: P) -> Link

Create a new link with no nested items.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl Default for Link

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Link

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Link> for SummaryItem

fn from(other: Link) -> SummaryItem

Converts to this type from the input type.

impl PartialEq for Link

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Link

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Link