Struct Config
struct Config { ... }
User preferences
Implementations
impl Config
fn builder() -> BuilderReturns a
Configbuilder.fn max_history_size(self: &Self) -> usizeTell the maximum length (i.e. number of entries) for the history.
fn history_duplicates(self: &Self) -> HistoryDuplicatesTell 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: &Self) -> boolTell 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: &Self) -> CompletionTypeCompletion behaviour.
By default,
CompletionType::Circular.fn completion_prompt_limit(self: &Self) -> usizeWhen listing completion alternatives, only display one screen of possibilities at a time (used for
CompletionType::Listmode).fn completion_show_all_if_ambiguous(self: &Self) -> boolDirectly show all alternatives when using list completion
By default, they are not, a second tab is needed
fn keyseq_timeout(self: &Self) -> Option<u16>Duration (milliseconds) Rustyline will wait for a character when reading an ambiguous key sequence (used for
EditMode::Vimode on unix platform).By default, no timeout (-1) or 500ms if
EditMode::Viis activated.fn edit_mode(self: &Self) -> EditModeEmacs or Vi mode
fn auto_add_history(self: &Self) -> boolTell if lines are automatically added to the history.
By default, they are not.
fn bell_style(self: &Self) -> BellStyleBell style: beep, flash or nothing.
fn color_mode(self: &Self) -> ColorModeTell if colors should be enabled.
By default, they are except if stdout is not a TTY.
fn grapheme_cluster_mode(self: &Self) -> GraphemeClusterModeTell if terminal supports grapheme clustering
fn behavior(self: &Self) -> BehaviorWhether to use stdio or not
By default, stdio is used.
fn tab_stop(self: &Self) -> u8Horizontal space taken by a tab.
By default, 8.
fn check_cursor_position(self: &Self) -> boolCheck if cursor position is at leftmost before displaying prompt.
By default, we don't check.
fn indent_size(self: &Self) -> u8Indentation size used by indentation commands
By default, 2.
fn enable_bracketed_paste(self: &Self) -> boolBracketed paste on unix platform
By default, it's enabled.
fn enable_synchronized_output(self: &Self) -> boolSynchronized output on unix platform
By default, it's enabled.
fn enable_signals(self: &Self) -> boolEnable or disable signals in termios
By default, it's disabled.
impl Clone for Config
fn clone(self: &Self) -> Config
impl Debug for Config
fn fmt(self: &Self, f: &mut $crate::fmt::Formatter<'_>) -> $crate::fmt::Result
impl Default for Config
fn default() -> Self
impl Eq for Config
impl Freeze for Config
impl PartialEq for Config
fn eq(self: &Self, other: &Config) -> bool
impl RefUnwindSafe for Config
impl Send for Config
impl StructuralPartialEq for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
impl<T> Any for Config
fn type_id(self: &Self) -> TypeId
impl<T> Borrow for Config
fn borrow(self: &Self) -> &T
impl<T> BorrowMut for Config
fn borrow_mut(self: &mut Self) -> &mut T
impl<T> CloneToUninit for Config
unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)
impl<T> From for Config
fn from(t: T) -> TReturns the argument unchanged.
impl<T> ToOwned for Config
fn to_owned(self: &Self) -> Tfn clone_into(self: &Self, target: &mut T)
impl<T, U> Into for Config
fn into(self: Self) -> UCalls
U::from(self).That is, this conversion is whatever the implementation of
[From]<T> for Uchooses to do.
impl<T, U> TryFrom for Config
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T, U> TryInto for Config
fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>