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 numbered chapters of the book, broken into one or more possibly named parts.

suffix_chapters: Vec<SummaryItem>

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

Trait Implementations

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 Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Summary

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Summary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Summary> for Summary

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

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

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

This method tests for !=.

impl Serialize for Summary

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 Summary