Struct ConfigSettings

pub struct ConfigSettings {
    config_name: ConfigName,
    app_name: String,
    interactivity: ConfigInteractivity,
}

The settings for a Config

Settings contain the ConfigName by which the configuration file is loaded and stored, the application name which uses the configuration (and also influences the file path of the configuration) and the interactivity setting, which defines whether missing items are prompted for interactively or not.

Fields

config_name: ConfigName

The configuration name (file name without suffix)

app_name: String

The name of the application using a Config

interactivity: ConfigInteractivity

The interactivity setting for the Config (and any DeviceConfig used by it)

Implementations

impl ConfigSettings

pub fn new( app_name: String, interactivity: ConfigInteractivity, config_name: Option<ConfigName>, ) -> Self

Creates a new ConfigSettings

Examples

use nethsm_config::{ConfigInteractivity, ConfigSettings};

// settings for an application called "my_app", that uses a custom configuration file named "my_app-config" interactively
let config_settings = ConfigSettings::new(
    "my_app".to_string(),
    ConfigInteractivity::Interactive,
    Some("my_app-config".parse()?),
);

// settings for an application called "my_app", that uses a default config file non-interactively
let config_settings = ConfigSettings::new(
    "my_app".to_string(),
    ConfigInteractivity::NonInteractive,
    None,
);

pub fn config_name(&self) -> ConfigName

Returns the configuration name

pub fn app_name(&self) -> String

Returns the application name

pub fn interactivity(&self) -> ConfigInteractivity

Returns the interactivity setting

Trait Implementations

impl Clone for ConfigSettings

fn clone(&self) -> ConfigSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSettings

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

Formats the value using the given formatter.

impl Default for ConfigSettings

fn default() -> ConfigSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigSettings

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigSettings

impl StructuralPartialEq for ConfigSettings