Struct mdbook::book::Link [−][src]
pub struct Link {
pub name: String,
pub location: Option<PathBuf>,
pub number: Option<SectionNumber>,
pub nested_items: Vec<SummaryItem>,
}
Expand description
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
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Performs the conversion.
Auto Trait Implementations
impl RefUnwindSafe for Link
impl UnwindSafe for Link
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self