[][src]Struct mdbook::renderer::RenderContext

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.


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.


impl RenderContext[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]

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

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

Load a RenderContext from its JSON representation.

Trait Implementations

impl Clone for RenderContext[src]

impl Debug for RenderContext[src]

impl<'de> Deserialize<'de> for RenderContext[src]

impl PartialEq<RenderContext> for RenderContext[src]

impl Serialize for RenderContext[src]

impl StructuralPartialEq for RenderContext[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,