Struct mdbook::renderer::CmdRenderer

pub struct CmdRenderer { /* fields omitted */ }

A generic renderer which will shell out to an arbitrary executable.

Rendering Protocol

When the renderer's render() method is invoked, CmdRenderer will spawn the cmd as a subprocess. The RenderContext is passed to the subprocess as a JSON string (using serde_json).

Note: The command used doesn't necessarily need to be a single executable (i.e. /path/to/renderer). The cmd string lets you pass in command line arguments, so there's no reason why it couldn't be python /path/to/renderer --from mdbook --to epub.

Anything the subprocess writes to stdin or stdout will be passed through to the user. While this gives the renderer maximum flexibility to output whatever it wants, to avoid spamming users it is recommended to avoid unnecessary output.

To help choose the appropriate output level, the RUST_LOG environment variable will be passed through to the subprocess, if set.

If the subprocess wishes to indicate that rendering failed, it should exit with a non-zero return code.

Methods

impl CmdRenderer

pub fn new(name: String, cmd: String) -> CmdRenderer

Create a new CmdRenderer which will invoke the provided cmd string.

Trait Implementations

impl Renderer for CmdRenderer

fn name(&self) -> &str

The Renderer's name.

fn render(&self, ctx: &RenderContext) -> Result<()>

Invoke the Renderer, passing in all the necessary information for describing a book.

impl Clone for CmdRenderer

fn clone(&self) -> CmdRenderer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CmdRenderer> for CmdRenderer

fn eq(&self, other: &CmdRenderer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CmdRenderer) -> bool

This method tests for !=.

impl Debug for CmdRenderer

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

Formats the value using the given formatter.