Struct ClapCmd

pub struct ClapCmd<State = (), History = MemHistory>
where
    State: Clone,
    History: History,
{
    pub output: String,
    pub info: String,
    pub warn: String,
    pub error: String,
    pub success: String,
    pub async_output: Arc<Mutex<String>>,
    /* private fields */
}

An interactive CLI interface, holding state and responsible for acquiring user input and assigning tasks to callback functions.

Fields

output: String

Available on crate feature test-runner only.

When test-runner feature is active, contains the output data from the previous command

info: String

Available on crate feature test-runner only.

When test-runner feature is active, contains the info data from the previous command

warn: String

Available on crate feature test-runner only.

When test-runner feature is active, contains the warn data from the previous command

error: String

Available on crate feature test-runner only.

When test-runner feature is active, contains the error data from the previous command

success: String

Available on crate feature test-runner only.

When test-runner feature is active, contains the success data from the previous command

async_output: Arc<Mutex<String>>

Available on crate feature test-runner only.

When test-runner feature is active, contains the async_output data from the previous command

Implementations

impl<State> ClapCmd<State>

where State: Clone,

pub fn with_state(state: State) -> Self

where State: Send + Sync + 'static,

Generate a default ClapCmd instance with the specified initial State

pub fn builder() -> ClapCmdBuilder

Generate a ClapCmdBuilder object used mainly to expose rustyline settings

pub fn set_state(&mut self, state: State)

Set the internal state that is provided to callbacks

pub fn unset_state(&mut self)

Delete the internal state

pub fn get_state(&self) -> Option<&State>

Retrieve the current state from a callback

pub fn get_state_mut(&mut self) -> Option<&mut State>

Retrieve a mutable reference to the current state from a callback

pub fn set_prompt(&mut self, prompt: &str)

Set the current prompt

pub fn set_continuation_prompt(&mut self, continuation_prompt: &str)

Set the continuation prompt

pub fn has_command(&self, command: &str) -> bool

Checks if a given &str is connected to a command

pub fn add_command(&mut self, callback: impl Callback<State>, command: Command)

Adds the specified command to the default group

pub fn remove_command(&mut self, command: &str)

Removes the command distinguished by the string command

pub fn group(name: &str) -> HandlerGroup<State>

Creates a new group that can be loaded an unloaded

pub fn unnamed_group() -> HandlerGroup<State>

Creates a new unnamed group that can be loaded an unloaded

pub fn add_group(&mut self, groups: &HandlerGroup<State>)

Adds all the commands in a group

pub fn remove_group(&mut self, groups: &HandlerGroup<State>)

Removes all the commands in a group

pub fn get_async_writer(&mut self) -> Result<impl Write, Box<dyn Error>>

Returns a thread-safe Write object that can be used to asyncronously write output to stdout without interferring with the promptline

pub fn output(&mut self, output: impl Into<String>)

Print a standard message to stdout

pub fn warn(&mut self, output: impl Into<String>)

Print a warning to stdout

pub fn error(&mut self, output: impl Into<String>)

Print an error to stdout

pub fn success(&mut self, output: impl Into<String>)

Print a success message to stdout

pub fn info(&mut self, output: impl Into<String>)

Print an informational message to stdout

pub fn read_line(&mut self, prompt: &str) -> Option<String>

Creates a prompt and reads a single line from the user

pub fn one_cmd(&mut self, line: &str) -> ClapCmdResult

Executes the appropriate command(s) specified by the line read from the user

pub fn run_loop(&mut self)

Run the command loop until a callback returns Err(Box::new(clapcmd::errors::ExitError))

Trait Implementations

impl<State> Default for ClapCmd<State>

where State: Clone + Default + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.