Struct Config

pub struct Config<T> {

    pub padding: Option<Delta<u8>>,
    pub env: HashMap<String, String>,
    pub font: Font,
    pub colors: Colors,
    pub window: WindowConfig,
    pub selection: Selection,
    pub shell: Option<Shell<'static>>,
    pub config_path: Option<PathBuf>,
    pub visual_bell: VisualBellConfig,
    pub scrolling: Scrolling,
    pub cursor: Cursor,
    pub working_directory: Option<PathBuf>,
    pub debug: Debug,
    pub ui_config: T,
    pub hold: bool,
    pub render_timer: Option<bool>,
    pub persistent_logging: Option<bool>,
    /* private fields */
}

Top-level config type

Fields

padding: Option<Delta<u8>>

Pixel padding

env: HashMap<String, String>

TERM env variable

font: Font

Font configuration

colors: Colors

window: WindowConfig

Window configuration

selection: Selection

shell: Option<Shell<'static>>

Path to a shell program to run on startup

config_path: Option<PathBuf>

Path where config was loaded from

visual_bell: VisualBellConfig

Visual bell configuration

scrolling: Scrolling

How much scrolling history to keep

cursor: Cursor

Cursor configuration

working_directory: Option<PathBuf>

Shell startup directory

debug: Debug

Debug options

ui_config: T

Additional configuration options not directly required by the terminal

hold: bool

Remain open after child process exits

render_timer: Option<bool>

persistent_logging: Option<bool>

Implementations

impl<T> Config<T>

pub fn tabspaces(&self) -> usize

pub fn draw_bold_text_with_bright_colors(&self) -> bool

pub fn render_timer(&self) -> bool

Should show render timer

pub fn live_config_reload(&self) -> bool

Live config reload

pub fn set_live_config_reload(&mut self, live_config_reload: bool)

pub fn dynamic_title(&self) -> bool

pub fn cursor_text_color(&self) -> Option<Rgb>

Cursor foreground color

pub fn cursor_cursor_color(&self) -> Option<Color>

Cursor background color

pub fn set_dynamic_title(&mut self, dynamic_title: bool)

pub fn alt_send_esc(&self) -> bool

Send escape sequences using the alt key

pub fn persistent_logging(&self) -> bool

Keep the log file after quitting Alacritty

pub fn background_opacity(&self) -> f32

Trait Implementations

impl<T: Debug> Debug for Config<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Config<T>

fn default() -> Config<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Config<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Config<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for Config<T>