Struct Builder

impl Builder

fn new() -> Self

Returns a Config builder.

fn max_history_size(self, max_size: usize) -> Result<Self>

Set the maximum length for the history.

fn history_ignore_dups(self, yes: bool) -> Result<Self>

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

By default, they are ignored.

fn history_ignore_space(self, yes: bool) -> Self

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

By default, they are saved.

fn completion_type(self, completion_type: CompletionType) -> Self

Set completion_type.

fn completion_prompt_limit(self, completion_prompt_limit: usize) -> Self

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

fn completion_show_all_if_ambiguous(self, completion_show_all_if_ambiguous: bool) -> Self

Choose whether or not to show all alternatives immediately when using list completion

By default, a second tab is needed.

fn keyseq_timeout(self, keyseq_timeout_ms: Option<u16>) -> Self

Timeout for ambiguous key sequences in milliseconds. Currently, it is used only to distinguish a single ESC from an ESC sequence. After seeing an ESC key, wait at most keyseq_timeout_ms for another byte.

fn edit_mode(self, edit_mode: EditMode) -> Self

Choose between Emacs or Vi mode.

fn auto_add_history(self, yes: bool) -> Self

Tell if lines are automatically added to the history.

By default, they are not.

fn bell_style(self, bell_style: BellStyle) -> Self

Set bell style: beep, flash or nothing.

fn color_mode(self, color_mode: ColorMode) -> Self

Forces colorization on or off.

By default, colorization is on except if stdout is not a TTY.

fn grapheme_cluster_mode(self, grapheme_cluster_mode: GraphemeClusterMode) -> Self

Tell if terminal supports grapheme clustering

fn behavior(self, behavior: Behavior) -> Self

Whether to use stdio or not

By default, stdio is used.

fn tab_stop(self, tab_stop: u8) -> Self

Horizontal space taken by a tab.

By default, 8

fn check_cursor_position(self, yes: bool) -> Self

Check if cursor position is at leftmost before displaying prompt.

By default, we don't check.

fn indent_size(self, indent_size: u8) -> Self

Indentation size

By default, 2

fn bracketed_paste(self, enabled: bool) -> Self

Enable or disable bracketed paste on unix platform

By default, it's enabled.

fn enable_signals(self, enable_signals: bool) -> Self

Enable or disable signals in termios

By default, it's disabled.

fn build(self) -> Config

Builds a Config with the settings specified so far.