Enum Dir

pub enum Dir {
    Project,
    Cache,
    Config,
    Data,
    DataLocal,
    Preference,
}

The different types of OS directories, provided by directories

Variants

Project

Platform	Value	Example
Linux	$XDG_CACHE_HOME/_project_path_ or $HOME/.cache/_project_path_	/home/alice/.cache/barapp
macOS	$HOME/Library/Caches/_project_path_	/Users/Alice/Library/Caches/com.Foo-Corp.Bar-App
Windows	{FOLDERID_LocalAppData}\_project_path_\cache	C:\Users\Alice\AppData\Local\Foo Corp\Bar App\cache

Cache

Platform	Value	Example
Linux	$XDG_CACHE_HOME/_project_path_ or $HOME/.cache/_project_path_	/home/alice/.cache/barapp
macOS	$HOME/Library/Caches/_project_path_	/Users/Alice/Library/Caches/com.Foo-Corp.Bar-App
Windows	{FOLDERID_LocalAppData}\_project_path_\cache	C:\Users\Alice\AppData\Local\Foo Corp\Bar App\cache

Config

Platform	Value	Example
Linux	$XDG_CONFIG_HOME/_project_path_ or $HOME/.config/_project_path_	/home/alice/.config/barapp
macOS	$HOME/Library/Application Support/_project_path_	/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
Windows	{FOLDERID_RoamingAppData}\_project_path_\config	C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config

Data

This is the default value.

Platform	Value	Example
Linux	$XDG_DATA_HOME/_project_path_ or $HOME/.local/share/_project_path_	/home/alice/.local/share/barapp
macOS	$HOME/Library/Application Support/_project_path_	/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
Windows	{FOLDERID_RoamingAppData}\_project_path_\data	C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\data

DataLocal

Platform	Value	Example
Linux	$XDG_DATA_HOME/_project_path_ or $HOME/.local/share/_project_path_	/home/alice/.local/share/barapp
macOS	$HOME/Library/Application Support/_project_path_	/Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App
Windows	{FOLDERID_LocalAppData}\_project_path_\data	C:\Users\Alice\AppData\Local\Foo Corp\Bar App\data

Preference

Platform	Value	Example
Linux	$XDG_CONFIG_HOME/_project_path_ or $HOME/.config/_project_path_	/home/alice/.config/barapp
macOS	$HOME/Library/Preferences/_project_path_	/Users/Alice/Library/Preferences/com.Foo-Corp.Bar-App
Windows	{FOLDERID_RoamingAppData}\_project_path_\config	C:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config

Trait Implementations

impl Clone for Dir

fn clone(&self) -> Dir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir

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

Formats the value using the given formatter.

impl Default for Dir

fn default() -> Dir

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dir

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Dir

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 Dir

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Dir

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Dir

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Dir

impl Eq for Dir

impl StructuralPartialEq for Dir