Struct rustyline::config::Builder

source ·
pub struct Builder { /* private fields */ }
Expand description

Configuration builder

Implementations§

source§

impl Builder

source

pub fn new() -> Self

Returns a Config builder.

source

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

Set the maximum length for the history.

source

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.

source

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.

source

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

Set completion_type.

source

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.

source

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.

source

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

Choose between Emacs or Vi mode.

source

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

Tell if lines are automatically added to the history.

By default, they are not.

source

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

Set bell style: beep, flash or nothing.

source

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.

source

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

Whether to use stdio or not

By default, stdio is used.

source

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

Horizontal space taken by a tab.

By default, 8

source

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.

source

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

Indentation size

By default, 2

source

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

Enable or disable bracketed paste on unix platform

By default, it’s enabled.

source

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

Enable or disable signals in termios

By default, it’s disabled.

source

pub fn build(self) -> Config

Builds a Config with the settings specified so far.

Trait Implementations§

source§

impl Clone for Builder

source§

fn clone(&self) -> Builder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Configurer for Builder

source§

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

Config accessor.
source§

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

Set the maximum length for the history.
source§

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. Read more
source§

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. Read more
source§

fn set_completion_type(&mut self, completion_type: CompletionType)

Set completion_type.
source§

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.
source§

fn set_keyseq_timeout(&mut self, keyseq_timeout_ms: Option<u16>)

Timeout for ambiguous key sequences in milliseconds.
source§

fn set_edit_mode(&mut self, edit_mode: EditMode)

Choose between Emacs or Vi mode.
source§

fn set_auto_add_history(&mut self, yes: bool)

Tell if lines are automatically added to the history. Read more
source§

fn set_bell_style(&mut self, bell_style: BellStyle)

Set bell style: beep, flash or nothing.
source§

fn set_color_mode(&mut self, color_mode: ColorMode)

Forces colorization on or off. Read more
source§

fn set_behavior(&mut self, behavior: Behavior)

Whether to use stdio or not Read more
source§

fn set_tab_stop(&mut self, tab_stop: usize)

Horizontal space taken by a tab. Read more
source§

fn set_check_cursor_position(&mut self, yes: bool)

Check if cursor position is at leftmost before displaying prompt. Read more
source§

fn set_indent_size(&mut self, size: usize)

Indentation size for indent/dedent commands Read more
source§

fn enable_bracketed_paste(&mut self, enabled: bool)

Enable or disable bracketed paste on unix platform Read more
source§

fn set_enable_signals(&mut self, enable_signals: bool)

Enable or disable signals in termios Read more
source§

impl Debug for Builder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Builder

source§

fn default() -> Builder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.