Struct Config

pub(crate) struct Config {
    pub(crate) port: u16,
    pub(crate) accounts: Vec<StaticAccount>,
}

Define the properties of the external configuration.

Fields

port: u16

Contain the port used for the server.

accounts: Vec<StaticAccount>

Contain the accounts supported by the application.

Implementations

impl Config

pub(crate) fn parse(config_path: &PathBuf) -> Result<Self, Box<dyn Error>>

Parse configuration from multiple supported sources. We currently have support to read from an external TOML file and environment variables.

The precedence order, in which one source will override configuration from another source, is as follows (configuration in #1 will be overridden by configuration #2).

1. External configuration file
2. Environment variables

Accounts configuration is recommended to always be defined using an external configuration file as it can be difficult to provide the necessary structure using environment variables.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

fn metadata(&self) -> Metadata

Returns the Metadata for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config