Struct Builder

impl Builder

fn new() -> Self

Returns a Config builder.

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

Set the maximum length for the history.

fn history_ignore_dups(self: 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.

fn history_ignore_space(self: 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.

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

Set completion_type.

fn completion_prompt_limit(self: 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.

fn completion_show_all_if_ambiguous(self: Self, completion_show_all_if_ambiguous: bool) -> Self

Choose whether or not to show all alternatives immediately when using list completion

By default, a second tab is needed.

fn keyseq_timeout(self: 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.

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

Choose between Emacs or Vi mode.

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

Tell if lines are automatically added to the history.

By default, they are not.

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

Set bell style: beep, flash or nothing.

fn color_mode(self: Self, color_mode: ColorMode) -> Self

Forces colorization on or off.

By default, colorization is on except if stdout is not a TTY.

fn grapheme_cluster_mode(self: Self, grapheme_cluster_mode: GraphemeClusterMode) -> Self

Tell if terminal supports grapheme clustering

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

Whether to use stdio or not

By default, stdio is used.

fn tab_stop(self: Self, tab_stop: u8) -> Self

Horizontal space taken by a tab.

By default, 8

fn check_cursor_position(self: Self, yes: bool) -> Self

Check if cursor position is at leftmost before displaying prompt.

By default, we don't check.

fn indent_size(self: Self, indent_size: u8) -> Self

Indentation size

By default, 2

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

Enable or disable bracketed paste on unix platform

By default, it's enabled.

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

Enable or disable signals in termios

By default, it's disabled.

fn build(self: Self) -> Config

Builds a Config with the settings specified so far.

impl Clone for Builder

fn clone(self: &Self) -> Builder

impl Configurer for Builder

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

impl Debug for Builder

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

impl Default for Builder

fn default() -> Builder

impl Freeze for Builder

impl RefUnwindSafe for Builder

impl Send for Builder

impl Sync for Builder

impl Unpin for Builder

impl UnwindSafe for Builder

impl<T> Any for Builder

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for Builder

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for Builder

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

impl<T> CloneToUninit for Builder

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

impl<T> From for Builder

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for Builder

fn to_owned(self: &Self) -> T

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

impl<T, U> Into for Builder

fn into(self: Self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom for Builder

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

impl<T, U> TryInto for Builder

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