Struct BookBuilder

pub struct BookBuilder { /* private fields */ }

A helper for setting up a new book and its directory structure.

Implementations

impl BookBuilder

pub fn new<P: Into<PathBuf>>(root: P) -> BookBuilder

Create a new BookBuilder which will generate a book in the provided root directory.

pub fn with_config(&mut self, cfg: Config) -> &mut BookBuilder

Set the Config to be used.

pub fn config(&self) -> &Config

Get the config used by the BookBuilder.

pub fn copy_theme(&mut self, copy: bool) -> &mut BookBuilder

Should the theme be copied into the generated book (so users can tweak it)?

pub fn create_gitignore(&mut self, create: bool) -> &mut BookBuilder

Should we create a .gitignore file?

pub fn build(&self) -> Result<MDBook>

Generate the actual book. This will:

• Create the directory structure.
• Stub out some dummy chapters and the SUMMARY.md.
• Create a .gitignore (if applicable)
• Create a themes directory and populate it (if applicable)
• Generate a book.toml file,
• Then load the book so we can build it or run tests.

Trait Implementations

impl Clone for BookBuilder

fn clone(&self) -> BookBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BookBuilder

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

Formats the value using the given formatter.

impl PartialEq for BookBuilder

fn eq(&self, other: &BookBuilder) -> 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 StructuralPartialEq for BookBuilder