Structs§
- Field
Path - This types indicates the location an error occured.
- Json
File Provider ConfigProviderwhich interperts the file contents as JSON- Toml
File Provider ConfigProviderwhich interperts the file contents as TOML- Yaml
File Provider ConfigProviderwhich interperts the file contents as YAML
Enums§
- Config
Error - Possible errors which can be produces when loading a config
- File
Content Provider - A generic source for file contents which can be used as a reference or an owned type.
See
FileContentProvider::into_ownedandFileContentProvider::as_borrowedfor conversion method. - Freeze
- Wraps a type to make it
Freezable. - Freeze
Combination - Interaction of two
Freezabletypes
Traits§
- Config
- Describes a Configuration which can be built from its associated
::Partialconfiguration. The Partial type contains optional variants of all fields of the Config. - Config
Provider - Generic provider for loading a partial configuration.
This can be any type which can produce a
T: DeserializeOwnedSee thejson,yamlandtomlfeatures and the associatedJsonFileProvider,YamlFileProviderandTomlFileProvidertypes for the built-in implementations. TheFileContentProviderprovides an ergonomic interface to specifiy the location/data of an input file. - Freezable
- Indicates that parts of this type can be “frozen”.
This means that these parts can not be overwriten by merges in any way.
See the derive macro for
Configfor how to mark fields asFreezable - Into
File Content Provider - Any type from which file contents can be read (see
FileContentProvider) - Partial
Config - A Partial variant of a
Config. This means that every field is optional allowing incremental merging of configs. - Reader
Factory - Helper trait to read from type-erased file sources
Type Aliases§
- Merge
Function - A function passed to
#[config(merge ... )]needs to match this signature. See the derive macro forConfigfor more details onmerge. - Validation
Function - A function passed to
#[config(validate ... )]needs to match this signature. See the derive macro forConfigfor more details onvalidate.
Derive Macros§
- Config
- Derives the
Configtrait for a struct and generates a companionPartialstruct.