Struct kas_core::config::Options

pub struct Options {
    pub config_path: PathBuf,
    pub theme_config_path: PathBuf,
    pub config_mode: ConfigMode,
}

Application configuration options

Fields

config_path: PathBuf

Config file path. Default: empty. See KAS_CONFIG doc.

theme_config_path: PathBuf

Theme config path. Default: empty.

config_mode: ConfigMode

Config mode. Default: Read.

Implementations

impl Options

pub fn from_env() -> Self

Construct a new instance, reading from environment variables

The following environment variables are read, in case-insensitive mode.

Config files

WARNING: file formats are not stable and may not be compatible across KAS versions (aside from patch versions)!

The KAS_CONFIG variable, if given, provides a path to the KAS config file, which is read or written according to KAS_CONFIG_MODE. If KAS_CONFIG is not specified, platform-default configuration is used without reading or writing. This may change to use a platform-specific default path in future versions.

The KAS_THEME_CONFIG variable, if given, provides a path to the theme config file, which is read or written according to KAS_CONFIG_MODE. If KAS_THEME_CONFIG is not specified, platform-default configuration is used without reading or writing. This may change to use a platform-specific default path in future versions.

The KAS_CONFIG_MODE variable determines the read/write mode:

• Read (default): read-only
• ReadWrite: read on start-up, write on exit
• WriteDefault: generate platform-default configuration and write it to the config path(s) specified, overwriting any existing config

Note: in the future, the default will likely change to a read-write mode, allowing changes to be written out.

pub fn init_theme_config<DS: DrawSharedImpl, T: Theme<DS>>( &self, theme: &mut T ) -> Result<(), Error>

Load/save and apply theme config on start

Requires feature “serde” to load/save config.

pub fn read_config(&self) -> Result<Config, Error>

Load/save KAS config on start

Requires feature “serde” to load/save config.

pub fn write_config<DS: DrawSharedImpl, T: Theme<DS>>( &self, _config: &Config, _theme: &T ) -> Result<(), Error>

Save all config (on exit or after changes)

Requires feature “serde” to save config.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Options

impl StructuralEq for Options

impl StructuralPartialEq for Options