Struct alacritty::cli::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,
    option: Vec<String>,
    pub config_options: Value,
    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>

Defines the X11 window ID (as a decimal integer) to embed Alacritty within.

config_file: Option<PathBuf>

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

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).

option: Vec<String>

Override configuration file options [example: cursor.style=Beam].

config_options: Value

CLI options for config overrides.

window_options: WindowOptions

Options which could be passed via IPC.

subcommands: Option<Subcommands>

Subcommand passed to the CLI.

Implementations

impl Options

pub fn new() -> Self

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

Override configuration file with options from the CLI.

pub fn log_level(&self) -> LevelFilter

Logging filter level.

Trait Implementations

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 StructOpt for Options

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.