Struct rustyline::config::Config

source · [−]

pub struct Config { /* private fields */ }

Expand description

User preferences

Implementations

source

impl Config

source

pub fn builder() -> Builder

Returns a Config builder.

source

pub fn max_history_size(&self) -> usize

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

source

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.

source

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.

source

pub fn completion_type(&self) -> CompletionType

Completion behaviour.

By default, CompletionType::Circular.

source

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

source

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.

source

pub fn edit_mode(&self) -> EditMode

Emacs or Vi mode

source

pub fn auto_add_history(&self) -> bool

Tell if lines are automatically added to the history.

By default, they are not.

source

pub fn bell_style(&self) -> BellStyle

Bell style: beep, flash or nothing.

source

pub fn color_mode(&self) -> ColorMode

Tell if colors should be enabled.

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

source

pub fn behavior(&self) -> Behavior

Whether to use stdio or not

By default, stdio is used.

source

pub fn tab_stop(&self) -> usize

Horizontal space taken by a tab.

By default, 8.

source

pub fn check_cursor_position(&self) -> bool

Check if cursor position is at leftmost before displaying prompt.

By default, we don’t check.

source

pub fn indent_size(&self) -> usize

Indentation size used by indentation commands

By default, 2.

source

pub fn enable_bracketed_paste(&self) -> bool

Bracketed paste on unix platform

By default, it’s enabled.

Trait Implementations

source

impl Clone for Config

source

fn clone(&self) -> Config

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 Debug for Config

source

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

Formats the value using the given formatter. Read more

source

impl Default for Config

source

fn default() -> Self

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

source

impl PartialEq<Config> for Config

source

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

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

source

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

This method tests for !=.

source

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

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> AsAny for T where
T: Any,

source

fn as_any(&self) -> &(dyn Any + 'static)

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct rustyline::config::Config

Implementations

impl Config

pub fn builder() -> Builder

pub fn max_history_size(&self) -> usize

pub fn history_duplicates(&self) -> HistoryDuplicates

pub fn history_ignore_space(&self) -> bool

pub fn completion_type(&self) -> CompletionType

pub fn completion_prompt_limit(&self) -> usize

pub fn keyseq_timeout(&self) -> i32

pub fn edit_mode(&self) -> EditMode

pub fn auto_add_history(&self) -> bool

pub fn bell_style(&self) -> BellStyle

pub fn color_mode(&self) -> ColorMode

pub fn behavior(&self) -> Behavior

pub fn tab_stop(&self) -> usize

pub fn check_cursor_position(&self) -> bool

pub fn indent_size(&self) -> usize

pub fn enable_bracketed_paste(&self) -> bool

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Default for Config

fn default() -> Self

impl PartialEq<Config> for Config

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

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

impl Copy for Config

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

impl<T> AsAny for T where
T: Any,

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

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

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

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

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

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