Struct mdbook::book::Summary

pub struct Summary {
    pub title: Option<String>,
    pub prefix_chapters: Vec<SummaryItem>,
    pub numbered_chapters: Vec<SummaryItem>,
    pub suffix_chapters: Vec<SummaryItem>,
}

The parsed SUMMARY.md, specifying how the book should be laid out.

Fields

title: Option<String>

An optional title for the SUMMARY.md, currently just ignored.

prefix_chapters: Vec<SummaryItem>

Chapters before the main text (e.g. an introduction).

numbered_chapters: Vec<SummaryItem>

The main chapters in the document.

suffix_chapters: Vec<SummaryItem>

Items which come after the main document (e.g. a conclusion).

Trait Implementations

impl Debug for Summary

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Summary

fn clone(&self) -> Summary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Summary

fn default() -> Summary

Returns the "default value" for a type.

impl PartialEq for Summary

fn eq(&self, __arg_0: &Summary) -> bool

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

fn ne(&self, __arg_0: &Summary) -> bool

This method tests for !=.