Crate settingsfile

Source
Expand description

An easy to use local settings library.

The settingsfile crate provides a simple and easy to use API that abstracts away most OS and serializing / deserializing functions so you can focus on saving and reading settings and configurations.

The user of this crate only needs to define a struct that implements Format, which defines the location and format of the configuration file. Then the user can call set and get functions to interact with that file and the data in that file.

settingsfile works primarily in memory and does not automatically save and load data from the disk, so ::load() and ::save() will need to manually be called.

Structs§

EmptyConfig
Settings
Basic one file settings
ShadowSettings
Complex settings that pulls data from 2 locations

Enums§

Type
Generic type enum used to work with data inside a Settings

Traits§

Format
Trait for defining the physical properties of a Settings
SupportedType
Trait for data types that can be inserted into a Settings.

Type Aliases§

SettingsRaw
A convience type that is used to shorten the required return type for the Format trait implemnetations.