Struct config::Config

#[non_exhaustive]
pub struct Config {
    pub auto_select_next: bool,
    pub diff_ignore_whitespace: DiffIgnoreWhitespaceSetting,
    pub diff_show_whitespace: DiffShowWhitespaceSetting,
    pub diff_space_symbol: String,
    pub diff_tab_symbol: String,
    pub diff_tab_width: u32,
    pub undo_limit: u32,
    pub git: GitConfig,
    pub key_bindings: KeyBindings,
    pub theme: Theme,
}

Represents the configuration options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

auto_select_next: bool

If to select the next line in the list after performing an action.

diff_ignore_whitespace: DiffIgnoreWhitespaceSetting

How to handle whitespace when calculating diffs.

diff_show_whitespace: DiffShowWhitespaceSetting

How to show whitespace in diffs.

diff_space_symbol: String

The symbol used to replace space characters.

diff_tab_symbol: String

The symbol used to replace tab characters.

diff_tab_width: u32

The display width of the tab character.

undo_limit: u32

The maximum number of undo steps.

git: GitConfig

Configuration options loaded directly from Git.

key_bindings: KeyBindings

Key binding configuration.

theme: Theme

Theme configuration.

Implementations

impl Config

pub fn new() -> Self

Create a new configuration with default values.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<&'_ Config> for Config

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: &Config) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&'_ Repository> for Config

fn try_from(repo: &Repository) -> Result<Self, Error>

Creates a new Config instance loading the Git Config using git::Repository.

Errors

Will return an Err if there is a problem loading the configuration.

type Error = Error

The type returned in the event of a conversion error.