Skip to main content

CliProgram

Struct CliProgram 

Source
pub struct CliProgram<Program>(/* private fields */);
Expand description

Carries a typed CLI program during fluent composition.

Implementations§

Source§

impl<Program> CliProgram<Program>

Source

pub fn merge<Other>( self, other: CliProgram<Other>, ) -> CliProgram<Merge<Program, Other>>

Records the composition of two typed CLI programs.

Source

pub fn cmd<Handler, Inputs, Mode>( self, name: &'static str, operation: Operation<Handler, Inputs, Mode>, ) -> CliProgram<Merge<Program, Command<Handler, Inputs, Mode>>>

Registers a typed operation under a command name.

Source

pub fn cmd_root<Handler, Inputs, Mode>( self, operation: Operation<Handler, Inputs, Mode>, ) -> CliProgram<Merge<Program, Command<Handler, Inputs, Mode>>>

Declares the program’s own command: the one a command line naming no command runs.

It sits beside named commands, which a command line naming one selects first.

Source

pub fn nest<Other>( self, name: &'static str, other: CliProgram<Other>, ) -> CliProgram<Merge<Program, Nest<Other>>>

Places other beneath the subcommand name.

Source

pub fn within<Handler, Inputs, Mode, Other>( self, operation: Operation<Handler, Inputs, Mode>, other: CliProgram<Other>, ) -> CliProgram<Merge<Program, Within<Handler, Inputs, Mode, Other>>>

Applies every command of other to the context operation answers.

Source

pub fn under(self, name: &'static str) -> Nest<Program>

Places this program beneath the subcommand name, with no program around it.

Source

pub fn into_program(self) -> Program

Removes the fluent wrapper and returns the first-order syntax tree.

Trait Implementations§

Source§

impl<Program: Debug> Debug for CliProgram<Program>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Program> Freeze for CliProgram<Program>
where Program: Freeze,

§

impl<Program> RefUnwindSafe for CliProgram<Program>
where Program: RefUnwindSafe,

§

impl<Program> Send for CliProgram<Program>
where Program: Send,

§

impl<Program> Sync for CliProgram<Program>
where Program: Sync,

§

impl<Program> Unpin for CliProgram<Program>
where Program: Unpin,

§

impl<Program> UnsafeUnpin for CliProgram<Program>
where Program: UnsafeUnpin,

§

impl<Program> UnwindSafe for CliProgram<Program>
where Program: 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<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<Source> CliPartsFor<ContextArg> for Source

Source§

const PARTS: &'static [&'static str] = const PARTS: &'static [&'static str] = &[];

The argument’s part names, in order.
Source§

const PART: &'static str = const PART: &'static str = "part";

What one part is called: field or alternative.
Source§

const WHOLE: &'static str = const WHOLE: &'static str = "argument";

What the whole is called: product or sum.
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> 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, 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.