Struct App

pub struct App<'b, T: Serialize + for<'a> Deserialize<'a>, H: CommandLineHandler> {
    pub commands: HashMap<&'b str, Command<T>>,
    pub state: T,
    pub handler: H,
    pub description: String,
}

Available on crate feature app only.

See the module level dicumentation. Note App closely mirrors state and so can be created from it (given the right trait bounds)

Fields

commands: HashMap<&'b str, Command<T>>

state: T

handler: H

description: String

Implementations

impl<'f: 't, 't, T: Serialize + for<'a> Deserialize<'a> + Send> App<'t, T, DefaultAsyncCLIHandler>

pub fn try_from_async<M: Display, H: AsyncHandler<T>, I: InputHandler>( shell: Shell<'f, T, M, H, I>, ) -> Result<Self, Box<dyn Error>>

Available on crate feature async only.

impl<T: Serialize + for<'a> Deserialize<'a>> App<'_, T, DefaultCommandLineHandler>

pub fn new(state: T, project_name: String) -> Result<Self, Box<dyn Error>>

Creates a new shell

impl<T: Serialize + for<'a> Deserialize<'a>, H: CommandLineHandler> App<'_, T, H>

pub fn new_with_handler(state: T, handler: H) -> Result<Self, Box<dyn Error>>

Creates a new shell with the given handler.

Note that this should be a handler which can deal with cli arguments, as in the FIRST ARGUMENT is the BINARY name.

pub fn load_cache(&mut self) -> Result<(), Box<dyn Error>>

Loads the state from cache.

impl<T: Serialize + for<'a> Deserialize<'a>, H: CommandLineHandler + Handler<T>> App<'_, T, H>

pub fn run_vec(&mut self, vec: Vec<String>) -> Result<bool>

Handles an vec of strings, like environment arguments.

Returns a bool on wether we have ‘quit’ or not

pub fn run_args(&mut self) -> Result<bool>

Runs from the env args

impl<T: Serialize + for<'a> Deserialize<'a> + Send, H: CommandLineHandler + AsyncHandler<T>> App<'_, T, H>

pub async fn run_vec_async(&mut self, vec: Vec<String>) -> Result<bool>

Available on crate feature async only.

Handles an vec of strings, like environment arguments.

Returns a bool on wether we have ‘quit’ or not

pub async fn run_args_async(&mut self) -> Result<bool>

Available on crate feature async only.

Runs from the env args

Trait Implementations

impl<'f: 't, 't, T: Serialize + for<'a> Deserialize<'a>, M: Display, H: Handler<T>, I: InputHandler> TryFrom<Shell<'f, T, M, H, I>> for App<'t, T, DefaultCommandLineHandler>

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(shell: Shell<'f, T, M, H, I>) -> Result<Self, Box<dyn Error>>

Performs the conversion.