Struct unidirs::UserDirs

pub struct UserDirs { /* private fields */ }

User directories are used when applications are directly run by local regular users. The folder locations vary greatly by platform, as each has their own rules about where to put them.

Linux

On Linux systems the folders are usually located in the home folder, but may be overridden by the common XDG user directory environment variables.

Type	Location
Cache	$XDG_CACHE_HOME/<app> or $HOME/.cache/<app>
Config	$XDG_CONFIG_HOME/<app> or $HOME/.config/<app>
Data	$XDG_DATA_HOME/<app> or $HOME/.local/share/<app>

Mac OS

Type	Location
Cache	$HOME/Library/Caches/<qual>.<org>.<app>
Config	$HOME/Library/Application Support/<qual>.<org>.<app>
Data	$HOME/Library/Application Support/<qual>.<org>.<app>

Windows

Type	Location
Cache	%LOCALAPPDATA%\<org>\<app>\cache
Config	%ROAMINGAPPDATA%\<org>\<app>\config
Data	%ROAMINGAPPDATA%\<org>\<app>\data

Implementations

impl UserDirs

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

Create a new instance with the given qualifier, organization and application. These values are used to create a custom directory structure depending on the operating system standards.

Trait Implementations

impl Clone for UserDirs

fn clone(&self) -> UserDirs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserDirs

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

Formats the value using the given formatter.

impl Directories for UserDirs

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 UserDirs

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UserDirs

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<UserDirs> for UserDirs

fn eq(&self, other: &UserDirs) -> 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 PartialOrd<UserDirs> for UserDirs

fn partial_cmp(&self, other: &UserDirs) -> 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 UserDirs

impl StructuralEq for UserDirs

impl StructuralPartialEq for UserDirs