[−][src]Struct mdbook_fluent::CmdPreprocessor
A custom preprocessor which will shell out to a 3rd-party program.
Preprocessing Protocol
When the supports_renderer()
method is executed, CmdPreprocessor
will
execute the shell command $cmd supports $renderer
. If the renderer is
supported, custom preprocessors should exit with a exit code of 0
,
any other exit code be considered as unsupported.
The run()
method is implemented by passing a (PreprocessorContext, Book)
tuple to the spawned command ($cmd
) as JSON via stdin
. Preprocessors
should then "return" a processed book by printing it to stdout
as JSON.
For convenience, the CmdPreprocessor::parse_input()
function can be used
to parse the input provided by mdbook
.
Exiting with a non-zero exit code while preprocessing is considered an
error. stderr
is passed directly through to the user, so it can be used
for logging or emitting warnings if desired.
Examples
An example preprocessor is available in this project's examples/
directory.
Methods
impl CmdPreprocessor
[src]
pub fn new(name: String, cmd: String) -> CmdPreprocessor
[src]
Create a new CmdPreprocessor
.
pub fn parse_input<R>(reader: R) -> Result<(PreprocessorContext, Book), Error> where
R: Read,
[src]
R: Read,
A convenience function custom preprocessors can use to parse the input
written to stdin
by a CmdRenderer
.
pub fn cmd(&self) -> &str
[src]
The command this Preprocessor
will invoke.
Trait Implementations
impl Clone for CmdPreprocessor
[src]
fn clone(&self) -> CmdPreprocessor
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for CmdPreprocessor
[src]
impl PartialEq<CmdPreprocessor> for CmdPreprocessor
[src]
fn eq(&self, other: &CmdPreprocessor) -> bool
[src]
fn ne(&self, other: &CmdPreprocessor) -> bool
[src]
impl Preprocessor for CmdPreprocessor
[src]
fn name(&self) -> &str
[src]
fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book, Error>
[src]
fn supports_renderer(&self, renderer: &str) -> bool
[src]
impl StructuralPartialEq for CmdPreprocessor
[src]
Auto Trait Implementations
impl RefUnwindSafe for CmdPreprocessor
impl Send for CmdPreprocessor
impl Sync for CmdPreprocessor
impl Unpin for CmdPreprocessor
impl UnwindSafe for CmdPreprocessor
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> AnyEq for T where
T: PartialEq<T> + Any,
T: PartialEq<T> + Any,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,