Struct rustyline::config::Config

pub struct Config { /* private fields */ }

User preferences

Implementations

impl Config

pub fn builder() -> Builder

Returns a Config builder.

pub fn max_history_size(&self) -> usize

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

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

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

pub fn completion_type(&self) -> CompletionType

Completion behaviour.

By default, CompletionType::Circular.

pub fn completion_prompt_limit(&self) -> usize

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

pub fn keyseq_timeout(&self) -> i32

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.

pub fn edit_mode(&self) -> EditMode

Emacs or Vi mode

pub fn auto_add_history(&self) -> bool

Tell if lines are automatically added to the history.

By default, they are not.

pub fn bell_style(&self) -> BellStyle

Bell style: beep, flash or nothing.

pub fn color_mode(&self) -> ColorMode

Tell if colors should be enabled.

By default, they are except if stdout is not a TTY.

pub fn behavior(&self) -> Behavior

Whether to use stdio or not

By default, stdio is used.

pub fn tab_stop(&self) -> usize

Horizontal space taken by a tab.

By default, 8.

pub fn check_cursor_position(&self) -> bool

Check if cursor position is at leftmost before displaying prompt.

By default, we don’t check.

pub fn indent_size(&self) -> usize

Indentation size used by indentation commands

By default, 2.

pub fn enable_bracketed_paste(&self) -> bool

Bracketed paste on unix platform

By default, it’s enabled.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Config

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config