Struct bdrck::configuration::Configuration

pub struct Configuration<T> { /* private fields */ }

A Configuration represents a set of configuration values, initially loaded from disk, and which can be persisted back to disk e.g. just before the application exits. Generally it is expected that only one instance per Identifier is needed globally, and the other functions in this module are intended to provide an easy singleton interface for this class.

Implementations

impl<T: Clone + Serialize + DeserializeOwned> Configuration<T>

pub fn new(
    id: Identifier,
    default: T,
    custom_path: Option<&Path>
) -> Result<Configuration<T>>

Initialize a new Configuration with the given identifier, default set of configuration values, and custom disk persistence path (optional). An error might occur if determining the persistence path to use fails, or if deserializing the previously persisted configuration (if any) fails.

pub fn get(&self) -> &T

Return this instance’s current set of configuration values.

pub fn set(&mut self, config: T)

Replace all existing configuration values with the given entirely new set of configuration values.

pub fn reset(&mut self)

Reset all of this instance’s configuration values back to their default values (specified previously on construction).

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

Persist this instance’s current configuration values to disk, so they can be re-loaded on the next construction.