Struct Cli 

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

Opaque struct holding the registered Commands

Implementations

impl<'a> Cli<'a>

pub fn new() -> Cli<'a>

Constructs a new Cli<'a>

This object holds all commands and callbacks registered with it

pub fn register<T: FnMut(Vec<&str>) + 'a>( &mut self, cmd: Vec<&'a str>, exec: T, ) -> Result<(), ()>

Registers a command with an exec callback When multiple commands get registered with matching prefixes, then a call to complete will return all “subcommands” available for the given input

cli.register(vec!["foo", "bar"], | args | { println!("called with: {:?}", args); });
// calling complete with "foo" would now return a Vec containing "bar"

cli.register(vec!["foo", "baz"], | args | { println!("called with: {:?}", args); });
// calling complete with "foo" would now return a Vec containing "bar" and "baz"

pub fn register_dyn_complete<T: FnMut(Vec<&str>) + 'a, U: for<'b> FnMut(Vec<&'b str>) -> Vec<&'a str> + 'a>( &mut self, cmd: Vec<&'a str>, exec: T, complete: U, ) -> Result<(), ()>

Registers a command with an exec callback and a dynamic complete callback This comes in handy if the completion is based on data that can change at runtime like a list of active sessions

cli.register_dyn_complete(vec!["foo"],
    | args | { println!("called with: {:?}", args); },
    | args | { vec!["bar", "baz"] });

cli.complete("foo"); // --> vec!["bar", "baz"]

pub fn complete<'b>(&mut self, argv: &'b str) -> Vec<&'a str>

Returns a Vector with “subcommands” that can either complete the current work or follow the given input for registered commands

cli.register(vec!["foo","bar"], | _ | {});
assert!(vec!["foo"] == cli.complete("f"));
assert!(vec!["bar"] == cli.complete("foo"));

cli.register(vec!["foo","baz"], | _ | {}); // -> vec!["bar", "baz"]

pub fn exec<'b>(&mut self, cmd: &'b str)

Calls the execute callback registered with a command specified by cmd

cli.register(vec!["foo"], | args | { println!("called with: {:?}", args); });
cli.exec("foo");