Enum unidirs::UnifiedDirs

pub enum UnifiedDirs {
    Local(LocalDirs),
    Service(ServiceDirs),
    User(UserDirs),
}

Unified directories provide a common interface over all different ways of constructing directory providers. It provides constructors for each variant.

The most significant function is UnifiedDirs::simple, giving an automatic selector for the right directory provider based on the way an application is run.

Variants

Local(LocalDirs)

Tuple Fields

0: LocalDirs

Local directories for development.

Service(ServiceDirs)

Tuple Fields

0: ServiceDirs

Directories for applications run as service.

User(UserDirs)

Tuple Fields

0: UserDirs

User specific application folders.

Implementations

impl UnifiedDirs

pub fn local() -> Option<Self>

Shorthand to create unified dirs with LocalDirs as backend.

pub fn local_at(base: impl AsRef<Utf8Path>) -> Self

Shorthand to create LocalDirs backed unified dirs at a specific location.

pub fn service(
    organization: impl AsRef<str>,
    application: impl AsRef<str>
) -> Self

Shorthand to create unified dirs with ServiceDirs as backend.

pub fn user(
    qualifier: impl AsRef<str>,
    organization: impl AsRef<str>,
    application: impl AsRef<str>
) -> Option<Self>

Shorthand to create unified dirs with UserDirs as backend.

pub fn simple<Q, O, A>(
    qualifier: Q,
    organization: O,
    application: A
) -> SimpleBuilder<Q, O, A> where
    Q: AsRef<str>,
    O: AsRef<str>,
    A: AsRef<str>, 

Create a builder for unified directories that uses various detection techniques to select the right backend. See the SimpleBuilder implementation for more details about the used techniques.

Trait Implementations

impl Clone for UnifiedDirs

fn clone(&self) -> UnifiedDirs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedDirs

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

Formats the value using the given formatter.

impl Directories for UnifiedDirs

fn cache_dir(&self) -> &Utf8Path

The cache directory is a location where an application can save any temporary data. The contents can potentially be deleted by the system at any time. Therefore, the application must be able to work without these files or be able to re-create them.

fn config_dir(&self) -> &Utf8Path

The config directory is where an application’s settings are stored. These are usually created by the user and loaded once at startup of the application.

fn data_dir(&self) -> &Utf8Path

The data directory hold an application’s state data, like a database. The folder is expected to persist during the normal runtime of the OS.

impl Hash for UnifiedDirs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for UnifiedDirs

fn cmp(&self, other: &UnifiedDirs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UnifiedDirs> for UnifiedDirs

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

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

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

This method tests for !=.

impl PartialOrd<UnifiedDirs> for UnifiedDirs

fn partial_cmp(&self, other: &UnifiedDirs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for UnifiedDirs

impl StructuralEq for UnifiedDirs

impl StructuralPartialEq for UnifiedDirs