Struct RenderContext 

#[non_exhaustive]
pub struct RenderContext {
    pub version: String,
    pub root: PathBuf,
    pub book: Book,
    pub config: Config,
    pub destination: PathBuf,
    pub chapter_titles: HashMap<PathBuf, String>,
}

The context provided to all renderers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

chapter_titles: HashMap<PathBuf, String>

Internal mapping of chapter titles.

This is used internally by mdbook to compute custom chapter titles. This should not be used outside of mdbook’s internals.

Implementations

impl RenderContext

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

Get the source directory’s (absolute) path on disk.

pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>

Load a RenderContext from its JSON representation.

Trait Implementations

impl Clone for RenderContext

fn clone(&self) -> RenderContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RenderContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RenderContext

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RenderContext