Struct clapcmd::ClapCmdBuilder

pub struct ClapCmdBuilder<State = ()> { /* private fields */ }

The ClapCmdBuilder is mostly a thin wrapper around the rustyline builder that allows you to specify how to interact with the readline interface. The main difference is that the default options for the ClapCmdBuilder includes auto_add_history

Implementations

impl<State> ClapCmdBuilder<State>

pub fn build(&self) -> ClapCmd<State>where State: Clone + Send + Sync + 'static,

Used to complete the build a return a ClapCmd struct

pub fn state(self, state: Option<State>) -> Self

Specify the starting state for the builder

pub fn about(self, about: &str) -> Self

Specify the “about” string displayed in the help menu

pub fn prompt(self, prompt: &str) -> Self

Specify the default prompt, this can later be altered using the set_prompt() method

pub fn continuation_prompt(self, continuation_prompt: &str) -> Self

Specify the default continuation prompt (for multiline input), this can later be altered using the set_continuation_prompt() method

pub fn without_help(self) -> Self

Do not add the default ‘help’ command to the repl

pub fn without_exit(self) -> Self

Do not add the default ‘exit’ command to the repl

Trait Implementations

impl<State: Clone> Clone for ClapCmdBuilder<State>

fn clone(&self) -> ClapCmdBuilder<State>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State> Configurer for ClapCmdBuilder<State>

fn config_mut(&mut self) -> &mut Config

Config accessor.

fn set_max_history_size(&mut self, max_size: usize) -> Result<(), ReadlineError>

Set the maximum length for the history.

fn set_history_ignore_dups(&mut self, yes: bool) -> Result<(), ReadlineError>

Tell if lines which match the previous history entry are saved or not in the history list.

fn set_history_ignore_space(&mut self, yes: bool)

Tell if lines which begin with a space character are saved or not in the history list.

fn set_completion_type(&mut self, completion_type: CompletionType)

Set completion_type.

fn set_completion_prompt_limit(&mut self, completion_prompt_limit: usize)

The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed.

fn set_keyseq_timeout(&mut self, keyseq_timeout_ms: i32)

Timeout for ambiguous key sequences in milliseconds.

fn set_edit_mode(&mut self, edit_mode: EditMode)

Choose between Emacs or Vi mode.

fn set_auto_add_history(&mut self, yes: bool)

Tell if lines are automatically added to the history.

fn set_bell_style(&mut self, bell_style: BellStyle)

Set bell style: beep, flash or nothing.

fn set_color_mode(&mut self, color_mode: ColorMode)

Forces colorization on or off.

fn set_behavior(&mut self, behavior: Behavior)

Whether to use stdio or not

fn set_tab_stop(&mut self, tab_stop: usize)

Horizontal space taken by a tab.

fn set_check_cursor_position(&mut self, yes: bool)

Check if cursor position is at leftmost before displaying prompt.

fn set_indent_size(&mut self, size: usize)

Indentation size for indent/dedent commands

fn enable_bracketed_paste(&mut self, enabled: bool)

Enable or disable bracketed paste on unix platform

impl<State> Default for ClapCmdBuilder<State>

fn default() -> Self

Returns the “default value” for a type.