Struct Config

impl Config

fn builder() -> Builder

Returns a Config builder.

fn max_history_size(&self) -> usize

Tell the maximum length (i.e. number of entries) for the history.

fn history_duplicates(&self) -> HistoryDuplicates

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) -> bool

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) -> CompletionType

Completion behaviour.

By default, CompletionType::Circular.

fn completion_prompt_limit(&self) -> usize

When listing completion alternatives, only display one screen of possibilities at a time (used for CompletionType::List mode).

fn completion_show_all_if_ambiguous(&self) -> bool

Directly show all alternatives when using list completion

By default, they are not, a second tab is needed

fn keyseq_timeout(&self) -> Option<u16>

Duration (milliseconds) Rustyline will wait for a character when reading an ambiguous key sequence (used for EditMode::Vi mode on unix platform).

By default, no timeout (-1) or 500ms if EditMode::Vi is activated.

fn edit_mode(&self) -> EditMode

Emacs or Vi mode

fn auto_add_history(&self) -> bool

Tell if lines are automatically added to the history.

By default, they are not.

fn bell_style(&self) -> BellStyle

Bell style: beep, flash or nothing.

fn color_mode(&self) -> ColorMode

Tell if colors should be enabled.

By default, they are except if stdout is not a TTY or NO_COLOR environment variable is set.

fn grapheme_cluster_mode(&self) -> GraphemeClusterMode

Tell if terminal supports grapheme clustering

fn behavior(&self) -> Behavior

Whether to use stdio or not

By default, stdio is used.

fn tab_stop(&self) -> u8

Horizontal space taken by a tab.

By default, 8.

fn check_cursor_position(&self) -> bool

Check if cursor position is at leftmost before displaying prompt.

By default, we don't check.

fn indent_size(&self) -> u8

Indentation size used by indentation commands

By default, 2.

fn enable_bracketed_paste(&self) -> bool

Bracketed paste on unix platform

By default, it's enabled.

fn enable_synchronized_output(&self) -> bool

Synchronized output on unix platform

By default, it's enabled.

fn enable_signals(&self) -> bool

Enable or disable signals in termios

By default, it's disabled.