[][src]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().


sections: Vec<BookItem>

The sections in this book.


impl Book[src]

pub fn new() -> Self[src]

Create an empty book.

pub fn iter(&self) -> BookItems<'_>

Notable traits for BookItems<'a>

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

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.


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.

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

Append a BookItem to the Book.

Trait Implementations

impl Clone for Book[src]

impl Debug for Book[src]

impl Default for Book[src]

impl<'de> Deserialize<'de> for Book[src]

impl PartialEq<Book> for Book[src]

impl Serialize for Book[src]

impl StructuralPartialEq for Book[src]

Auto Trait Implementations

impl RefUnwindSafe for Book

impl Send for Book

impl Sync for Book

impl Unpin for Book

impl UnwindSafe for Book

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,