Struct Configuration

pub struct Configuration {
    pub version: Version,
    pub recents: Vec<PathBuf>,
    pub libraries: HashMap<String, PathBuf>,
    pub logging: LogConfiguration,
}

Configuration for the DungeonRS application.

Fields

version: Version

The version of the software that created the configuration file.

recents: Vec<PathBuf>

A list of recently opened files, used in the UI to show recently opened projects.

libraries: HashMap<String, PathBuf>

A map of asset libraries currently known to the application. This is used so that assets can be referred to relative to a library, which in turn is referred to by name. The result is that if the same library is located in different paths (as is often the case across multiple devices and/or users), asset references will still work consistently.

logging: LogConfiguration

Controls how the application should handle logging.

Note that some configuration requires additional features to be enabled to work.

Implementations

impl Configuration

pub fn load() -> Result<Self>

Attempt to load configuration from CONFIG_FILE_NAME. If the CONFIG_FILE_NAME does not exist, a default configuration is generated and returned.

Note that while it creates an instance of Configuration, it doesn’t create the CONFIG_FILE_NAME file unless you call Configuration::save directly.

Errors

The method will return an error in two scenarios:

• The application failed to retrieve the config path (see [utils::config_path]
• The config file failed to deserialise

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

Attempts to save the configuration.

Errors

• Error returned when the underlying calls to either current_exe or File::create fails.
• [serialization::SerializationError] Thrown when a serialisation-related error occurs.

Trait Implementations

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configuration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Configuration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Resource for Configuration

where Self: Send + Sync + 'static,