Struct App 

pub struct App<'a> { /* private fields */ }

Help and completion over the whole command tree, static and runtime alike.

Implementations

impl<'a> App<'a>

pub fn spec(&self) -> &'a Spec

The merged tree: the host’s commands with the catalogued ones grafted in.

pub fn help(self, path: &str, long: bool) -> Option<String>

Render help for a static or runtime command path. The empty path is the root.

long is the --help / -h distinction: the full page or the summary.

pub async fn completion_request(self, argv: &[OsString]) -> Option<String>

Answer a hidden __complete_word__ invocation, or return None for ordinary argv.

Two answerers, one line. Up to the catch-all the words are the host’s, and the host’s own tables answer for them — the same engine, so registered completers, multicall projections and a --candidates request all keep working, and the catalogued names are added where a subcommand belongs. Past it the words are a plugin’s, and that plugin’s spec answers alone. A name in neither is a program nobody here can describe, and the answer is nothing.

pub async fn complete_request( self, request: &CompletionRequest, ) -> Completions<'static>

The answer to a parsed request, before it is written the way a shell reads it.

For a caller holding a Split rather than a shell’s argv, build the request with CompletionRequest::for_split.

Trait Implementations

impl<'a> Clone for App<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for App<'a>

impl<'a> Debug for App<'a>

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

Formats the value using the given formatter.