Struct mdbook::book::Chapter

pub struct Chapter {
    pub name: String,
    pub content: String,
    pub number: Option<SectionNumber>,
    pub sub_items: Vec<BookItem>,
    pub path: PathBuf,
    pub parent_names: Vec<String>,
}

The representation of a "chapter", usually mapping to a single file on disk however it may contain multiple sub-chapters.

Fields

name: String

The chapter's name.

content: String

The chapter's contents.

number: Option<SectionNumber>

The chapter's section number, if it has one.

sub_items: Vec<BookItem>

Nested items.

path: PathBuf

The chapter's location, relative to the SUMMARY.md file.

parent_names: Vec<String>

An ordered list of the names of each chapter above this one, in the hierarchy.

Methods

impl Chapter

pub fn new<P: Into<PathBuf>>(
    name: &str,
    content: String,
    path: P,
    parent_names: Vec<String>
) -> Chapter

Create a new chapter with the provided content.

Trait Implementations

impl From<Chapter> for BookItem

fn from(other: Chapter) -> BookItem

Performs the conversion.

impl Debug for Chapter

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

Formats the value using the given formatter.

impl Clone for Chapter

fn clone(&self) -> Chapter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Chapter

fn default() -> Chapter

Returns the "default value" for a type.

impl PartialEq for Chapter

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

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

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

This method tests for !=.

impl Display for Chapter

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

Formats the value using the given formatter.