Trait embedded_cli::service::Help

pub trait Help {
    // Required method
    fn help<W: Write<Error = E>, E: Error>(
        request: HelpRequest<'_>,
        writer: &mut Writer<'_, W, E>
    ) -> Result<(), HelpError<E>>;

    // Provided method
    fn longest_command() -> usize { ... }
}

Required Methods

fn help<W: Write<Error = E>, E: Error>( request: HelpRequest<'_>, writer: &mut Writer<'_, W, E> ) -> Result<(), HelpError<E>>

Try to process help request Use given writer to print help text If help request cannot be processed by this service, Err(HelpError::UnknownCommand) must be returned

Provided Methods

fn longest_command() -> usize

Return length of longest command, contained in this service

Object Safety

This trait is not object safe.

Implementors

impl<'a> Help for RawCommand<'a>