Skip to main content

CliDirect

Struct CliDirect 

Source
pub struct CliDirect<Handle> { /* private fields */ }
Expand description

Interprets a CLI program as a command line, applying its operations to Handle.

It parses the words, selects the command by its path, decodes the arguments through their sources, applies the operation, and renders the outcome. --help or -h prints help built from the same program.

Implementations§

Source§

impl<Handle> CliDirect<Handle>

Source

pub fn new(handle: Handle) -> Self

Interprets programs against handle, the context every operation is applied to.

Source

pub fn named(self, name: impl Into<String>) -> Self

Names the program in help instead of the first word of the command line; an empty name shows each command beneath no program name.

Source

pub fn failures_after(self, prefix: FailurePrefix) -> Self

Writes failures after prefix instead of error.

Source

pub fn usage_status(self, status: u8) -> Self

Ends words that do not make a command with status instead of USAGE_STATUS, as utilities that state their own do: BusyBox test exits 2, most of its others 1.

Source

pub fn selecting(self, name: Option<&'static str>) -> Self

Compiles only the commands beneath the first-layer name name, as a multicall executable invoked by that name runs no other; help then lists only those. None compiles every command.

Source

pub fn version(self, version: &'static str) -> Self

Answers --version or -V, written before any command, with the program’s name and version, and lists it in the program’s help.

Source

pub fn unknown_command( self, status: u8, message: impl Fn(&str) -> String + Send + Sync + 'static, ) -> Self

Ends a command line that names no command with status and the message message writes for the word, instead of a usage error with the program’s help.

Source

pub fn run_once<Program, Words>(self, program: Program, words: Words) -> Running
where Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>, Words: IntoIterator, Words::Item: Into<OsString>,

Runs program on a full command line, applying the selected command to the handle itself.

It takes the handle, so a handle that owns what it reads, and cannot be cloned, runs too.

Source

pub fn run_once_blocking<Program, Words>( self, program: Program, words: Words, ) -> Exit
where Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>, Words: IntoIterator, Words::Item: Into<OsString>,

Runs program on a full command line with the handle itself, waiting on the calling thread.

Source

pub fn run_main<Program>(self, program: Program) -> !
where Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>,

Runs program as the process’s command line with the handle itself, writes what it shows, and ends the process with its status.

Source§

impl<Handle> CliDirect<Handle>
where Handle: Clone,

Source

pub fn run<Program, Words>( &self, program: Program, words: Words, ) -> impl Future<Output = Exit> + use<Handle, Program, Words>
where Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>, Words: IntoIterator, Words::Item: Into<OsString>,

Runs program on a full command line, its first word the program’s name.

Source

pub fn run_blocking<Program, Words>( &self, program: Program, words: Words, ) -> Exit
where Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>, Words: IntoIterator, Words::Item: Into<OsString>,

Runs program on a full command line and waits for its exit, on the calling thread.

Auto Trait Implementations§

§

impl<Handle> !RefUnwindSafe for CliDirect<Handle>

§

impl<Handle> !UnwindSafe for CliDirect<Handle>

§

impl<Handle> Freeze for CliDirect<Handle>
where Handle: Freeze,

§

impl<Handle> Send for CliDirect<Handle>
where Handle: Send,

§

impl<Handle> Sync for CliDirect<Handle>
where Handle: Sync,

§

impl<Handle> Unpin for CliDirect<Handle>
where Handle: Unpin,

§

impl<Handle> UnsafeUnpin for CliDirect<Handle>
where Handle: UnsafeUnpin,

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]

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

const PART: &'static str = "part"

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

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.