Struct mdbook::renderer::RenderContext [−][src]
pub struct RenderContext {
pub version: String,
pub root: PathBuf,
pub book: Book,
pub config: Config,
pub destination: PathBuf,
// some fields omitted
}
Expand description
The context provided to all renderers.
Fields
version: String
Which version of mdbook
did this come from (as written in mdbook
’s
Cargo.toml
). Useful if you know the renderer is only compatible with
certain versions of mdbook
.
root: PathBuf
The book’s root directory.
book: Book
A loaded representation of the book itself.
config: Config
The loaded configuration file.
destination: PathBuf
Where the renderer must put any build artefacts generated. To allow renderers to cache intermediate results, this directory is not guaranteed to be empty or even exist.
Implementations
Create a new RenderContext
.
Get the source directory’s (absolute) path on disk.
Load a RenderContext
from its JSON representation.
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for RenderContext
impl Send for RenderContext
impl Sync for RenderContext
impl Unpin for RenderContext
impl UnwindSafe for RenderContext
Blanket Implementations
Mutably borrows from an owned value. Read more