Struct Setup

pub struct Setup {
    pub dump_config: bool,
    pub clean: bool,
    pub check: bool,
    pub dump_layout: Option<String>,
    pub dump_swap_layout: Option<String>,
    pub dump_plugins: Option<Option<PathBuf>>,
    pub generate_completion: Option<String>,
    pub generate_auto_start: Option<String>,
}

Fields

dump_config: bool

Dump the default configuration file to stdout

clean: bool

Disables loading of configuration file at default location, loads the defaults that zellij ships with

check: bool

Checks the configuration of zellij and displays currently used directories

dump_layout: Option<String>

Dump specified layout to stdout

dump_swap_layout: Option<String>

Dump the specified swap layout file to stdout

dump_plugins: Option<Option<PathBuf>>

Dump the builtin plugins to DIR or “DATA DIR” if unspecified

generate_completion: Option<String>

Generates completion for the specified shell

generate_auto_start: Option<String>

Generates auto-start script for the specified shell

Implementations

impl Setup

pub fn from_cli_args( cli_args: &CliArgs, ) -> Result<(Config, Layout, Options, Config, Options), ConfigError>

Entrypoint from main Merges options from the config file and the command line options into [Options], the command line options superceeding the layout file options, superceeding the config file options:

1. command line options (zellij options)
2. layout options (layout.kdl / zellij --layout)
3. config options (config.kdl)

pub fn from_cli(&self) -> Result<()>

General setup helpers

pub fn from_cli_with_options( &self, opts: &CliArgs, config_options: &Options, ) -> Result<()>

Checks the merged configuration

pub fn check_defaults_config( opts: &CliArgs, config_options: &Options, ) -> Result<()>

Trait Implementations

impl Args for Setup

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl Clone for Setup

fn clone(&self) -> Setup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Setup

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

Formats the value using the given formatter.

impl Default for Setup

fn default() -> Setup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Setup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Setup

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 Serialize for Setup

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.