Struct ReadWriteFactory 

pub struct ReadWriteFactory { /* private fields */ }

Available on crate feature serde only.

Read and write config from disk

Implementations

impl ReadWriteFactory

pub fn new(path: PathBuf, mode: ConfigMode) -> Self

Construct with specified path and mode

pub fn fail_on_error(self) -> Self

Fail immediately in case of read error

By default, Config::default will be returned on read error.

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_CONFIG_MODE variable determines the read/write mode:

• Read: 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
• If not specified the mode is automatically determined depending on what path resolves to.

If KAS_CONFIG_FAIL_ON_ERROR is true, config read errors are fatal. Otherwise default configuration will be used on read error.

Trait Implementations

impl Clone for ReadWriteFactory

fn clone(&self) -> ReadWriteFactory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigFactory for ReadWriteFactory

fn read_config(&mut self) -> Result<Rc<RefCell<Config>>, Error>

Construct a Config object

fn writer(self) -> Option<Box<dyn FnMut(&Config)>>

Return optional config-writing fn

impl Debug for ReadWriteFactory

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

Formats the value using the given formatter.

impl Hash for ReadWriteFactory

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 ReadWriteFactory

fn eq(&self, other: &ReadWriteFactory) -> 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 Eq for ReadWriteFactory

impl StructuralPartialEq for ReadWriteFactory