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 }
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.
Methods
impl RenderContext
[src]
impl RenderContext
pub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
[src]
pub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
Create a new RenderContext
.
pub fn source_dir(&self) -> PathBuf
[src]
pub fn source_dir(&self) -> PathBuf
Get the source directory's (absolute) path on disk.
pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
[src]
pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
Load a RenderContext
from its JSON representation.
Trait Implementations
impl Debug for RenderContext
[src]
impl Debug for RenderContext
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for RenderContext
[src]
impl Clone for RenderContext
fn clone(&self) -> RenderContext
[src]
fn clone(&self) -> RenderContext
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for RenderContext
[src]
impl PartialEq for RenderContext
fn eq(&self, other: &RenderContext) -> bool
[src]
fn eq(&self, other: &RenderContext) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &RenderContext) -> bool
[src]
fn ne(&self, other: &RenderContext) -> bool
This method tests for !=
.
Auto Trait Implementations
impl Send for RenderContext
impl Send for RenderContext
impl Sync for RenderContext
impl Sync for RenderContext