Struct ov_config::ExampleConfig

pub struct ExampleConfig {
    pub c_p_a_t_h: String,
    pub Section: Section,
}

Configuration schema struct.

Basically is a struct of all sections. User will need to use Config.Section.Key to access value.

Fields

c_p_a_t_h: String

Section: Section

Methods

impl ExampleConfig

pub fn verify(&self) -> Result<(), OVConfigError>

Sanity check convenience function

This function will exec the closure on each field with the input of the field's value. Change c_p_a_t_h will change the path that cached inthe configuration object.

pub fn get_config_no_verify<T: AsRef<str> + ?Sized>(
    path: &T
) -> Result<Self, OVConfigError>

Get configuration without auto verification.

Will use default value if specific field is not found in the configuration file.

Argument:

• path: Path to the configuration. This path will be cached in the object for refresh and flush.

Return:

Will return configuration object on success.

pub fn get_config<T: AsRef<str> + ?Sized>(
    path: &T
) -> Result<Self, OVConfigError>

Get configuration with auto verification.

Will use default value if specific field is not found in the configuration file.

Argument:

• path: Path to the configuration. This path will be cached in the object for refresh and flush.

Return:

Will return configuration object on success.

pub fn refresh(&mut self) -> Result<(), OVConfigError>

Read the configuration file and update current object.

This function will automatically do sanity check on the value.

pub fn refresh_no_verify(&mut self) -> Result<(), OVConfigError>

Read the configuration file and update current object.

This function will NOT automatically do sanity check on the value.

pub fn flush(&self) -> Result<(), OVConfigError>

Flush whatever in configuration object to file.

This function will automatically do sanity check on the value.

pub fn flush_no_verify(&self) -> Result<(), OVConfigError>

Flush whatever in configuration object to file.

This function will automatically do sanity check on the value.

Trait Implementations

impl PartialEq<ExampleConfig> for ExampleConfig

fn eq(&self, other: &ExampleConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ExampleConfig) -> bool

This method tests for !=.

impl Default for ExampleConfig

fn default() -> ExampleConfig

Returns the "default value" for a type.

impl Debug for ExampleConfig

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

Formats the value using the given formatter.