Skip to main content

CommandDescription

Struct CommandDescription 

Source
pub struct CommandDescription {
    pub path: Vec<&'static str>,
    pub doc: &'static str,
    pub argument_names: &'static [&'static str],
    pub arguments: Vec<ArgumentInfo>,
    pub context: Vec<ArgumentInfo>,
    pub conventions: Conventions,
}
Expand description

Describes one command as a describing interpretation observes it.

Its path comes from the program, its documentation and argument names from the reified operation, and its arguments from the declared sources.

Fields§

§path: Vec<&'static str>

The subcommand names leading to the command, ending with its own name.

§doc: &'static str

The documentation of the extension method the command applies.

§argument_names: &'static [&'static str]

The argument names of the extension method, in order.

§arguments: Vec<ArgumentInfo>

Every argument with the source it is read from, in the operation’s order.

§context: Vec<ArgumentInfo>

The global arguments of every context the command is applied within, outermost first.

§conventions: Conventions

How the command’s words are read as its options and operands.

Implementations§

Source§

impl CommandDescription

Source

pub fn of<Operation, Sources>(name: &'static str, sources: &Sources) -> Self
where Operation: OperationAlg, Sources: CliSources<Operation::Args>,

Describes Operation declared under name, its arguments read from sources.

Trait Implementations§

Source§

impl Clone for CommandDescription

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandDescription

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CommandDescription

Source§

impl PartialEq for CommandDescription

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CommandDescription

Auto Trait Implementations§

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<This> CliDeclarationLawsExt<This> for This

Source§

fn law_cli_declaration<Operation, Sources, Mode, Commands>( &self, name: &'static str, operation: Operation, sources: Sources, mode: Mode, conventions: Conventions, ) -> Result<(), &'static str>
where This: CliOperationAlg<Operation, Sources, Mode, Commands = Commands> + CliCommandsObserved<Commands = Commands>, Operation: OperationAlg, Sources: CliSources<<Operation as OperationAlg>::Args>,

Checks that operation declared under name with sources describes exactly that, with one argument per operation argument, in order, and distinct spellings and positions.

Source§

impl<This> CliOutcomeLawsExt<This> for This

Source§

fn law_cli_outcome<Output>(&self, output: Output) -> Result<(), &'static str>
where This: CliOutcomeOf<Output>, <This as CliOutcomeOf<Output>>::Error: CliFailureAlg,

Checks that output read under this mode exits with zero exactly when it succeeds.

Source§

impl<This> CliProgramExt<This> for This

Source§

fn compile_cli<Program>( &self, program: Program, ) -> <Program as CliProgramAlg<This>>::Commands
where Program: CliProgramAlg<This>,

Compiles a named CLI program with this interpreter.

Source§

impl<Source> CliStatedFor<ContextArg> for Source

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<This> ShapeProgramExt<This> for This

Source§

fn compile_shape<Program>( &self, program: Program, ) -> <Program as ShapeProgramAlg<This>>::Ty
where Program: ShapeProgramAlg<This>,

Folds a declaration with this interpretation.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.