Trait mdbook::preprocess::Preprocessor [−][src]
pub trait Preprocessor { fn name(&self) -> &str; fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>; fn supports_renderer(&self, _renderer: &str) -> bool { ... } }
An operation which is run immediately after loading a book into memory and before it gets rendered.
Required Methods
fn name(&self) -> &str
Get the Preprocessor
's name.
fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>
Run this Preprocessor
, allowing it to update the book before it is
given to a renderer.
Provided Methods
fn supports_renderer(&self, _renderer: &str) -> bool
A hint to MDBook
whether this preprocessor is compatible with a
particular renderer.
By default, always returns true
.
Implementors
impl Preprocessor for IndexPreprocessor
impl Preprocessor for LinkPreprocessor
impl Preprocessor for CmdPreprocessor