Struct Options

pub struct Options {
    pub print_events: bool,
    pub ref_test: bool,
    pub embed: Option<String>,
    pub config_file: Option<PathBuf>,
    pub socket: Option<PathBuf>,
    quiet: u8,
    verbose: u8,
    pub daemon: bool,
    pub config_options: ParsedOptions,
    pub window_options: WindowOptions,
    pub subcommands: Option<Subcommands>,
}

CLI options for the main Alacritty executable.

Fields

print_events: bool

Print all events to STDOUT.

ref_test: bool

Generates ref test.

embed: Option<String>

X11 window ID to embed Alacritty within (decimal or hexadecimal with “0x” prefix).

config_file: Option<PathBuf>

Specify alternative configuration file [default: $XDG_CONFIG_HOME/alacritty/alacritty.toml].

socket: Option<PathBuf>

Path for IPC socket creation.

quiet: u8

Reduces the level of verbosity (the min level is -qq).

verbose: u8

Increases the level of verbosity (the max level is -vvv).

daemon: bool

Do not spawn an initial window.

config_options: ParsedOptions

CLI options for config overrides.

window_options: WindowOptions

Options which can be passed via IPC.

subcommands: Option<Subcommands>

Subcommand passed to the CLI.

Implementations

impl Options

pub fn new() -> Self

pub fn override_config(&mut self, config: &mut UiConfig)

Override configuration file with options from the CLI.

pub fn log_level(&self) -> LevelFilter

Logging filter level.

Trait Implementations

impl Args for Options

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl CommandFactory for Options

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl FromArgMatches for Options

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Options

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.