Struct Builder 

pub struct Builder { /* private fields */ }

Configuration builder

Implementations

impl Builder

pub fn new() -> Self

Returns a Config builder.

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

Set the maximum length for the history.

pub 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.

pub 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.

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

Set completion_type.

pub 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.

pub 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.

pub 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.

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

Choose between Emacs or Vi mode.

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

Tell if lines are automatically added to the history.

By default, they are not.

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

Set bell style: beep, flash or nothing.

pub 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.

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

Tell if terminal supports grapheme clustering

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

Whether to use stdio or not

By default, stdio is used.

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

Horizontal space taken by a tab.

By default, 8

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

Check if cursor position is at leftmost before displaying prompt.

By default, we don’t check.

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

Indentation size

By default, 2

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

Enable or disable bracketed paste on unix platform

By default, it’s enabled.

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

Enable or disable signals in termios

By default, it’s disabled.

pub fn build(self) -> Config

Builds a Config with the settings specified so far.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurer for Builder

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

Config accessor.

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

Set the maximum length for the history.

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

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_show_all_if_ambiguous( &mut self, completion_show_all_if_ambiguous: bool, )

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

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: Option<u16>)

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_grapheme_cluster_mode( &mut self, grapheme_cluster_mode: GraphemeClusterMode, )

Tell if terminal supports grapheme clustering

fn set_tab_stop(&mut self, tab_stop: u8)

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: u8)

Indentation size for indent/dedent commands

fn enable_bracketed_paste(&mut self, enabled: bool)

Enable or disable bracketed paste on unix platform

fn enable_synchronized_output(&mut self, enabled: bool)

Enable or disable synchronized output on unix platform

fn set_enable_signals(&mut self, enable_signals: bool)

Enable or disable signals in termios

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes