Trait mdbook::preprocess::Preprocessor

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.

Loading content...

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.

Loading content...

Implementors

impl Preprocessor for CmdPreprocessor

fn name(&self) -> &str

fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>

fn supports_renderer(&self, renderer: &str) -> bool

impl Preprocessor for IndexPreprocessor

fn name(&self) -> &str

fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>

impl Preprocessor for LinkPreprocessor

fn name(&self) -> &str

fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>

Loading content...