pub struct BookBuilder { /* fields omitted */ }
A helper for setting up a new book and its directory structure.
Create a new BookBuilder
which will generate a book in the provided
root directory.
Set the Config
to be used.
Get the config used by the BookBuilder
.
Should the theme be copied into the generated book (so users can tweak
it)?
Should we create a .gitignore
file?
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.
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static