Skip to main content

FnCommand

Struct FnCommand 

Source
pub struct FnCommand<F> { /* private fields */ }

Implementations§

Source§

impl<F> FnCommand<F>

Source

pub fn with_args(self, choices: &[&[&'static str]]) -> FnCommand<F>

One inner slice per position; trailing free-form args may be omitted.

Source

pub fn with_value_choices( self, key: &'static str, values: &[&'static str], ) -> FnCommand<F>

First Tab completes to key=, subsequent Tabs cycle these values.

Source

pub fn with_long_help(self, long: &'static str) -> FnCommand<F>

Trait Implementations§

Source§

impl<Ctx, F> Command<Ctx> for FnCommand<F>
where F: FnMut(&[&str], &mut Ctx, &mut ConsoleWriter) -> Result<(), Error> + 'static,

Source§

fn name(&self) -> &str

Source§

fn help(&self) -> &str

Source§

fn long_help(&self) -> String

\n breaks paint as separate scrollback entries.
Source§

fn arg_choices(&self, arg_index: usize) -> &[&'static str]

Source§

fn arg_value_choices(&self, _arg_index: usize, key: &str) -> &[&'static str]

key carries no trailing =; empty means free-form.
Source§

fn run( &mut self, args: &[&str], ctx: &mut Ctx, out: &mut ConsoleWriter, ) -> Result<(), Error>

Recoverable issues go to out.error(..); unrecoverable ones return Err.
Source§

fn arg_choices_ctx<'a>( &'a self, arg_index: usize, prior: &[&str], ) -> &'a [&'static str]

prior is the arg tokens before the cursor.
Source§

fn arg_value_choices_ctx<'a>( &'a self, arg_index: usize, key: &str, prior: &[&str], ) -> &'a [&'static str]

Auto Trait Implementations§

§

impl<F> Freeze for FnCommand<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for FnCommand<F>
where F: RefUnwindSafe,

§

impl<F> Send for FnCommand<F>
where F: Send,

§

impl<F> Sync for FnCommand<F>
where F: Sync,

§

impl<F> Unpin for FnCommand<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for FnCommand<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for FnCommand<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more