Struct mdbook::book::Book

pub struct Book {
    pub sections: Vec<BookItem>,
    // some fields omitted
}

A dumb tree structure representing a book.

For the moment a book is just a collection of BookItems which are accessible by either iterating (immutably) over the book with iter(), or recursively applying a closure to each section to mutate the chapters, using for_each_mut().

Fields

sections: Vec<BookItem>

The sections in this book.

Methods

impl Book

pub fn new() -> Self

Create an empty book.

Important traits for BookItems<'a>

impl<'a> Iterator for BookItems<'a> type Item = &'a BookItem;

pub fn iter(&self) -> BookItems

Get a depth-first iterator over the items in the book.

pub fn for_each_mut<F>(&mut self, func: F) where     F: FnMut(&mut BookItem),

Recursively apply a closure to each item in the book, allowing you to mutate them.

Note

Unlike the iter() method, this requires a closure instead of returning an iterator. This is because using iterators can possibly allow you to have iterator invalidation errors.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn push_item<I: Into<BookItem>>(&mut self, item: I) -> &mut Self

Append a BookItem to the Book.

Trait Implementations

impl Debug for Book

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

Formats the value using the given formatter.

impl Clone for Book

fn clone(&self) -> Book

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Book

fn default() -> Book

Returns the "default value" for a type.

impl PartialEq for Book

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

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

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

This method tests for !=.