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>
impl<Handle> CliDirect<Handle>
Sourcepub fn new(handle: Handle) -> Self
pub fn new(handle: Handle) -> Self
Interprets programs against handle, the context every operation is applied to.
Sourcepub fn named(self, name: impl Into<String>) -> Self
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.
Sourcepub fn failures_after(self, prefix: FailurePrefix) -> Self
pub fn failures_after(self, prefix: FailurePrefix) -> Self
Writes failures after prefix instead of error.
Sourcepub fn usage_status(self, status: u8) -> Self
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.
Sourcepub fn selecting(self, name: Option<&'static str>) -> Self
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.
Sourcepub fn version(self, version: &'static str) -> Self
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.
Sourcepub fn unknown_command(
self,
status: u8,
message: impl Fn(&str) -> String + Send + Sync + 'static,
) -> Self
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.
Sourcepub fn run_once<Program, Words>(self, program: Program, words: Words) -> Runningwhere
Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>,
Words: IntoIterator,
Words::Item: Into<OsString>,
pub fn run_once<Program, Words>(self, program: Program, words: Words) -> Runningwhere
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.
Sourcepub fn run_once_blocking<Program, Words>(
self,
program: Program,
words: Words,
) -> Exitwhere
Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>,
Words: IntoIterator,
Words::Item: Into<OsString>,
pub fn run_once_blocking<Program, Words>(
self,
program: Program,
words: Words,
) -> Exitwhere
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§impl<Handle> CliDirect<Handle>where
Handle: Clone,
impl<Handle> CliDirect<Handle>where
Handle: Clone,
Sourcepub 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>,
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.
Sourcepub fn run_blocking<Program, Words>(
&self,
program: Program,
words: Words,
) -> Exitwhere
Program: CliProgramAlg<DirectCompiler<Handle>, Commands = Vec<Entry<Handle>>>,
Words: IntoIterator,
Words::Item: Into<OsString>,
pub fn run_blocking<Program, Words>(
&self,
program: Program,
words: Words,
) -> Exitwhere
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<This> CliDeclarationLawsExt<This> for This
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>,
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
impl<This> CliOutcomeLawsExt<This> for This
Source§impl<Source> CliPartsFor<ContextArg> for Source
impl<Source> CliPartsFor<ContextArg> for Source
Source§impl<This> CliProgramExt<This> for This
impl<This> CliProgramExt<This> for This
Source§fn compile_cli<Program>(
&self,
program: Program,
) -> <Program as CliProgramAlg<This>>::Commandswhere
Program: CliProgramAlg<This>,
fn compile_cli<Program>(
&self,
program: Program,
) -> <Program as CliProgramAlg<This>>::Commandswhere
Program: CliProgramAlg<This>,
Compiles a named CLI program with this interpreter.
impl<Source> CliStatedFor<ContextArg> for Source
Source§impl<This> ShapeProgramExt<This> for This
impl<This> ShapeProgramExt<This> for This
Source§fn compile_shape<Program>(
&self,
program: Program,
) -> <Program as ShapeProgramAlg<This>>::Tywhere
Program: ShapeProgramAlg<This>,
fn compile_shape<Program>(
&self,
program: Program,
) -> <Program as ShapeProgramAlg<This>>::Tywhere
Program: ShapeProgramAlg<This>,
Folds a declaration with this interpretation.