Struct mdbook::book::Link
[−]
[src]
pub struct Link { pub name: String, pub location: 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: 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.
Methods
impl Link
[src]
fn new<S: Into<String>, P: AsRef<Path>>(name: S, location: P) -> Link
[src]
Create a new link with no nested items.
Trait Implementations
impl Debug for Link
[src]
impl Clone for Link
[src]
fn clone(&self) -> Link
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for Link
[src]
fn eq(&self, __arg_0: &Link) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Link) -> bool
[src]
This method tests for !=
.