Struct conrig::path::ConfigPathMetadata

pub struct ConfigPathMetadata<'p, 'cn> {
    pub project_path: ProjectPath<'p>,
    pub config_name: &'cn [&'cn str],
    pub default_format: FileFormat,
    pub config_option: ConfigOption,
}

The main entry point of conrig.

This defines multiple configuration options for your application.

See the crate’s documentation for more information.

Fields

project_path: ProjectPath<'p>

Your application’s project path.

See directories::ProjectDirs for more information.

config_name: &'cn [&'cn str]

Your configuration files’ names.

At least one should be specified.

default_format: FileFormat

The default language of your configuration files.

config_option: ConfigOption

Extra configuration options.

Implementations

impl<'p, 'cn> ConfigPathMetadata<'p, 'cn>

pub const fn new( project_path: ProjectPath<'p>, config_name: &'cn [&'cn str], default_format: FileFormat, config_option: ConfigOption ) -> Self

Create a new ConfigPathMetadata.

pub const fn with_project_path(self, project_path: ProjectPath<'p>) -> Self

Modify the project_path field.

pub const fn with_config_name(self, config_name: &'cn [&'cn str]) -> Self

Modify the config_name field.

pub const fn with_default_format(self, default_format: FileFormat) -> Self

Modify the default_format field.

pub const fn no_default_format(self) -> Self

Set the default_format to DEFAULT_FILE_FORMAT.

pub const fn with_config_option(self, config_option: ConfigOption) -> Self

Modify the config_option field.

pub fn sys_config_dir(&self) -> Option<PathBuf>

Get the configuration directory of your application.

See directories::ProjectDirs::config_dir for more information.

pub fn sys_preference_dir(&self) -> Option<PathBuf>

Get the preference directory of your application.

See directories::ProjectDirs::preference_dir for more information.

pub fn sys_dir(&self) -> Option<PathBuf>

Get the system-level config directory of your application.

Depends on ConfigOption.config_sys_type:

• Preference: sys_preference_dir.
• Config: sys_config_dir.

pub fn default_sys_config_file(&self) -> Result<PathBuf, ConrigError>

Format the default system-level configuration file.

pub fn default_local_config_file(&self) -> Result<PathBuf, ConrigError>

Format the default configuration file in the current folder.

pub fn default_config_file(&self) -> Result<PathBuf, ConrigError>

Format the default configuration file, depending on the ConfigOption.sys_override_local.

pub fn search_config_file<'a>( &'a self ) -> Result<ConfigFile<'a, 'p, 'cn>, ConrigError>

Search for a configuration file.

This will check for two places:

• Your system-level configuration directory.
• The current directory.

The sequence is determined by ConfigOption.sys_override_local.

pub fn read<T: DeserializeOwned>(&self) -> Result<T, ConrigError>

Read a configuration file, using the default searching method.

This is equivalent to self.search_config_file()?.fallback_default()?.read().

pub fn write<T: Serialize>(&self, value: &T) -> Result<(), ConrigError>

Write into a configuration file, using the default searching method.

This is equivalent to self.search_config_file()?.fallback_default()?.write(&foo).

pub fn read_or_default<T: Serialize + DeserializeOwned + Default>( &self ) -> Result<T, ConrigError>

Read a configuration file, or creating a new one with the default value.

This is equivalent to self.search_config_file()?.fallback_default()?.read_or_default::<T>().

pub fn read_or_new<T: Serialize + DeserializeOwned>( &self, default: T ) -> Result<T, ConrigError>

Read a configuration file, or creating a new one with the default value provided.

This is equivalent to self.search_config_file()?.fallback_default()?.read_or_default::<T>().

Trait Implementations

impl<'p, 'cn> Clone for ConfigPathMetadata<'p, 'cn>

fn clone(&self) -> ConfigPathMetadata<'p, 'cn>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'p, 'cn> Debug for ConfigPathMetadata<'p, 'cn>

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

Formats the value using the given formatter.

impl<'p, 'cn> PartialEq for ConfigPathMetadata<'p, 'cn>

fn eq(&self, other: &ConfigPathMetadata<'p, 'cn>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'p, 'cn> Eq for ConfigPathMetadata<'p, 'cn>

impl<'p, 'cn> StructuralPartialEq for ConfigPathMetadata<'p, 'cn>