Struct ConfigFile 

pub struct ConfigFile {
    pub(crate) default_technology_settings: Option<ConfigTechnologySettings>,
    pub(crate) contexts: Vec<ConfigContextSettings>,
}

Representation of a VOA configuration file.

Fields

default_technology_settings: Option<ConfigTechnologySettings>

Technology defaults for an OS.

contexts: Vec<ConfigContextSettings>

Context overrides for an OS.

Note

This list can be empty, if technology_defaults is set, else there has to be at least one entry.

Implementations

impl ConfigFile

pub fn new( technology_settings: Option<ConfigTechnologySettings>, context_override: Vec<ConfigContextSettings>, ) -> Result<Self, Error>

Creates a new ConfigFile.

pub fn from_yaml_str(s: &str) -> Result<Self, Error>

Creates a ConfigFile from a string slice containing YAML data.

pub fn from_yaml_file( path: impl AsRef<Path>, file_type: ConfigFileType, ) -> Result<Self, Error>

Creates a ConfigFile from a file containing YAML data.

The additional file_type sets the origin according to whether the file is a default configuration file or a drop-in configuration file.

pub fn to_yaml_string(&self) -> Result<String, Error>

Serializes self as a YAML string.

pub fn default_technology_settings(&self) -> Option<&ConfigTechnologySettings>

Returns the optional ConfigTechnologySettings.

pub fn contexts(&self) -> &[ConfigContextSettings]

Returns a reference to the list of ConfigContextSettings.

pub fn origins(&self) -> &[ConfigOrigin]

Returns a reference to the list of config file origins.

Note

This returns an empty list, if neither settings nor context settings contain origins. However, this can not happen, as the validation of ConfigFile does not allow it.

Trait Implementations

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for ConfigFile

type Context = ()

A user-provided context.

fn validate_into( &self, __garde_user_ctx: &Self::Context, __garde_path: &mut dyn FnMut() -> Path, __garde_report: &mut Report, )

Validates Self, aggregating all validation errors into Report.

fn validate(&self) -> Result<(), Report>

where Self::Context: Default,

Validates Self, returning an Err with an aggregate of all errors if the validation failed.

fn validate_with(&self, ctx: &Self::Context) -> Result<(), Report>

Validates Self, returning an Err with an aggregate of all errors if the validation failed.