Struct PreprocessorContext 

#[non_exhaustive]
pub struct PreprocessorContext {
    pub root: PathBuf,
    pub config: Config,
    pub renderer: String,
    pub mdbook_version: String,
    pub chapter_titles: RefCell<HashMap<PathBuf, String>>,
}

Extra information for a Preprocessor to give them more context when processing a book.

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.

root: PathBuf

The location of the book directory on disk.

config: Config

The book configuration (book.toml).

renderer: String

The Renderer this preprocessor is being used with.

mdbook_version: String

The calling mdbook version.

chapter_titles: RefCell<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 PreprocessorContext

pub fn new(root: PathBuf, config: Config, renderer: String) -> Self

Create a new PreprocessorContext.

Trait Implementations

impl Clone for PreprocessorContext

fn clone(&self) -> PreprocessorContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreprocessorContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreprocessorContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PreprocessorContext

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

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 PreprocessorContext