pub struct RenderContext {
pub version: String,
pub root: PathBuf,
pub book: Book,
pub config: Config,
pub destination: PathBuf,
/* private fields */
}
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§
Source§impl RenderContext
impl RenderContext
Sourcepub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q,
) -> RenderContext
pub fn new<P, Q>( root: P, book: Book, config: Config, destination: Q, ) -> RenderContext
Create a new RenderContext
.
Sourcepub fn source_dir(&self) -> PathBuf
pub fn source_dir(&self) -> PathBuf
Get the source directory’s (absolute) path on disk.
Sourcepub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
Load a RenderContext
from its JSON representation.
Trait Implementations§
Source§impl Clone for RenderContext
impl Clone for RenderContext
Source§fn clone(&self) -> RenderContext
fn clone(&self) -> RenderContext
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for RenderContext
impl Debug for RenderContext
Source§impl<'de> Deserialize<'de> for RenderContext
impl<'de> Deserialize<'de> for RenderContext
Source§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
Source§impl PartialEq for RenderContext
impl PartialEq for RenderContext
Source§impl Serialize for RenderContext
impl Serialize for RenderContext
impl StructuralPartialEq for RenderContext
Auto Trait Implementations§
impl Freeze for RenderContext
impl RefUnwindSafe for RenderContext
impl Send for RenderContext
impl Sync for RenderContext
impl Unpin for RenderContext
impl UnwindSafe for RenderContext
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more