Struct Hooks 

pub struct Hooks { /* private fields */ }

Per-command hook configuration.

Hooks are registered per-command path and executed in order.

Implementations

impl Hooks

pub fn new() -> Self

Creates a new empty hooks configuration.

pub fn is_empty(&self) -> bool

Returns true if no hooks are registered.

pub fn pre_dispatch<F>(self, f: F) -> Self

where F: Fn(&ArgMatches, &CommandContext) -> Result<(), HookError> + Send + Sync + 'static,

Adds a pre-dispatch hook.

pub fn post_dispatch<F>(self, f: F) -> Self

where F: Fn(&ArgMatches, &CommandContext, Value) -> Result<Value, HookError> + Send + Sync + 'static,

Adds a post-dispatch hook.

pub fn post_output<F>(self, f: F) -> Self

where F: Fn(&ArgMatches, &CommandContext, RenderedOutput) -> Result<RenderedOutput, HookError> + Send + Sync + 'static,

Adds a post-output hook.

pub fn run_pre_dispatch( &self, matches: &ArgMatches, ctx: &CommandContext, ) -> Result<(), HookError>

Runs all pre-dispatch hooks.

pub fn run_post_dispatch( &self, matches: &ArgMatches, ctx: &CommandContext, data: Value, ) -> Result<Value, HookError>

Runs all post-dispatch hooks, chaining transformations.

pub fn run_post_output( &self, matches: &ArgMatches, ctx: &CommandContext, output: RenderedOutput, ) -> Result<RenderedOutput, HookError>

Runs all post-output hooks, chaining transformations.

Trait Implementations

impl Clone for Hooks

fn clone(&self) -> Hooks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hooks

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

Formats the value using the given formatter.

impl Default for Hooks

fn default() -> Hooks

Returns the “default value” for a type.