Struct CmdPreprocessor 

pub struct CmdPreprocessor { /* private fields */ }

A custom preprocessor which will shell out to a 3rd-party program.

See https://rust-lang.github.io/mdBook/for_developers/preprocessors.html for a description of the preprocessor protocol.

Implementations

impl CmdPreprocessor

pub fn new( name: String, cmd: String, root: PathBuf, optional: bool, ) -> CmdPreprocessor

Create a new CmdPreprocessor.

pub fn cmd(&self) -> &str

The command this Preprocessor will invoke.

Trait Implementations

impl Clone for CmdPreprocessor

fn clone(&self) -> CmdPreprocessor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CmdPreprocessor

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

Formats the value using the given formatter.

impl PartialEq for CmdPreprocessor

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

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.

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

A hint to MDBook whether this preprocessor is compatible with a particular renderer.

impl StructuralPartialEq for CmdPreprocessor