Struct ConfigSetupOptions

pub struct ConfigSetupOptions {
    pub pretty: bool,
    pub format: Option<ConfigFormat>,
    pub save_on_drop: bool,
}

Used to configure the Config object

Attributes

• pretty - Makes the contents of the config file more humanly-readable. When false, it will try to compact down the config file data so it takes up less storage space. I recommend you keep it on unless you know what you’re doing as most modern systems have enough space to handle spaces and newline characters even at scale.

• format - An Option containing an enum of type ConfigFormat. Used to specify the format language to use (ex: JSON, TOML, etc.)
  If you don’t select a format (Option::None) it will try to guess the format based on the file extension and enabled features.
  If this step fails, an UnknownFormatError will be returned.

More options are to be added later!

Pass .. Default::default() at the end of your construction to prevent yourself from getting errors in the future!

Examples:

use fast_config::{ConfigSetupOptions, ConfigFormat, Config};
use serde::{Serialize, Deserialize};

// Creating a config struct to store our data
#[derive(Serialize, Deserialize)]
pub struct MyData {
    pub some_data: i32
}

fn main() {
    // Creating the options
    let options = ConfigSetupOptions {
        pretty: false,
        format: Some(ConfigFormat::JSON),
        .. Default::default()
    };

    // Creating the data and setting it's default values
    let data = MyData {
        some_data: 12345
    };

    // Creating the config itself
    let mut config = Config::from_options("./config/myconfig", options, data).unwrap();
    // [.. do stuff here]
}

Fields

pretty: bool

format: Option<ConfigFormat>

save_on_drop: bool

👎Deprecated: This option can result in I/O during program exit and can potentially corrupt config files! Use [Config::save] while your program is exiting instead!

Trait Implementations

impl Clone for ConfigSetupOptions

fn clone(&self) -> ConfigSetupOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ConfigSetupOptions

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<ConfigSetupOptions> for InternalOptions

type Error = String

This function converts a ConfigSetupOptions into an internally-used InternalOptions.

This function is not recommended to be used outside the fast_config source code unless you know what you’re doing and accept the risks.
The signature or behaviour of the function may be modified in the future.

fn try_from(options: ConfigSetupOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ConfigSetupOptions