Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub max_history_len: usize,
    pub max_line_len: usize,
    pub multiline_mode: bool,
    pub terminal_mode: TerminalMode,
    pub column_width: ColumnWidth,
    pub term_name: Option<String>,
}
Expand description

Configuration settings for an Editor instance.

Fields§

§max_history_len: usize

Maximum number of history entries to keep in memory.

§max_line_len: usize

Maximum line length in bytes.

§multiline_mode: bool

Enable multi-line editing mode.

§terminal_mode: TerminalMode

Mode for TTY terminal detection.

§column_width: ColumnWidth

Mode for determining column width.

§term_name: Option<String>

Explicit terminal name override (or None to check TERM env var).

Implementations§

Source§

impl Config

Source

pub fn with_terminal_mode(self, mode: TerminalMode) -> Self

Sets the terminal detection mode.

Source

pub fn with_column_width(self, column_width: ColumnWidth) -> Self

Sets the column width determination mode.

Source

pub fn with_term_name(self, name: Option<impl Into<String>>) -> Self

Sets an explicit terminal name override.

Source

pub fn resolve_terminal_capability(&self) -> TerminalCapability

Resolves this configuration specification into a TerminalCapability level.

Source

pub fn resolve_operating_mode( &self, is_terminal: impl FnOnce() -> bool, ) -> OperatingMode

Resolves this configuration specification into a concrete OperatingMode for the editor.

is_terminal is invoked only when self.terminal_mode == TerminalMode::Auto to resolve whether the input stream is a TTY.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.