Struct ProjectPath

pub struct ProjectPath<'a> {
    pub qualifier: &'a str,
    pub organization: &'a str,
    pub application: &'a str,
}

Your application’s metadata.

This is mainly used to figure out the system-level storage directory for your application.

See directories::ProjectDirs for more information.

Fields

qualifier: &'a str

The qualifier of your application.

E.g. com in com.GitHub.application.

organization: &'a str

The organization name of your application.

E.g. GitHub in com.GitHub.application.

application: &'a str

Your application’s name.

E.g. application in com.GitHub.application.

Implementations

impl<'a> ProjectPath<'a>

pub const fn new( qualifier: &'a str, organization: &'a str, application: &'a str, ) -> Self

Create a new ProjectPath.

pub const fn with_qualifier(self, qualifier: &'a str) -> Self

Modify the qualifier field.

pub const fn with_organization(self, organization: &'a str) -> Self

Modify the organization field.

pub const fn with_application(self, application: &'a str) -> Self

Modify the application 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, cfg_sys_type: ConfigType) -> 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.

Trait Implementations

impl<'a> Clone for ProjectPath<'a>

fn clone(&self) -> ProjectPath<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProjectPath<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ProjectPath<'a>

fn eq(&self, other: &ProjectPath<'a>) -> 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<'a> Eq for ProjectPath<'a>

impl<'a> StructuralPartialEq for ProjectPath<'a>