Struct Chapter

pub struct Chapter {
    pub name: String,
    pub content: String,
    pub number: Option<SectionNumber>,
    pub sub_items: Vec<BookItem>,
    pub path: Option<PathBuf>,
    pub source_path: Option<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: Option<PathBuf>

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

Note: After the index preprocessor runs, any README files will be modified to be index.md. If you need access to the actual filename on disk, use Chapter::source_path instead.

This is None for a draft chapter.

source_path: Option<PathBuf>

The chapter’s source file, relative to the SUMMARY.md file.

Note: Beware that README files will internally be treated as index.md via the Chapter::path field. The source_path field exists if you need access to the true file path.

This is None for a draft chapter.

parent_names: Vec<String>

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

Implementations

impl Chapter

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

Create a new chapter with the provided content.

pub fn new_draft(name: &str, parent_names: Vec<String>) -> Self

Create a new draft chapter that is not attached to a source markdown file (and thus has no content).

pub fn is_draft_chapter(&self) -> bool

Check if the chapter is a draft chapter, meaning it has no path to a source markdown file.

Trait Implementations

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

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

Formats the value using the given formatter.

impl Default for Chapter

fn default() -> Chapter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Chapter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Chapter

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

Formats the value using the given formatter.

impl From<Chapter> for BookItem

fn from(other: Chapter) -> BookItem

Converts to this type from the input type.

impl PartialEq for Chapter

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Chapter

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 Chapter