Skip to main content

PlatformDirs

Struct PlatformDirs 

Source
pub struct PlatformDirs {
    pub home: PathBuf,
    pub config: PathBuf,
    pub data: PathBuf,
    pub cache: PathBuf,
    pub state: Option<PathBuf>,
    pub runtime: Option<PathBuf>,
    pub temp: PathBuf,
}
Expand description

Platform-standard directories for the current user / process.

§Platform notes

Windows

  • Home: %USERPROFILE%
  • Config / roaming data: %APPDATA%
  • Local data / cache: %LOCALAPPDATA%
  • Temp: %TEMP% or %TMP%

macOS

  • Home: $HOME
  • Config / data: ~/Library/Application Support
  • Cache: ~/Library/Caches
  • Temp: $TMPDIR

Linux

  • Home: $HOME
  • Config: $XDG_CONFIG_HOME or ~/.config
  • Data: $XDG_DATA_HOME or ~/.local/share
  • Cache: $XDG_CACHE_HOME or ~/.cache
  • State: $XDG_STATE_HOME or ~/.local/state when available
  • Runtime: $XDG_RUNTIME_DIR when available
  • Temp: $TMPDIR or system temp

Fields§

§home: PathBuf

User home directory.

§config: PathBuf

User configuration directory.

§data: PathBuf

User data directory.

§cache: PathBuf

User cache directory.

§state: Option<PathBuf>

User state directory (XDG state), when available.

§runtime: Option<PathBuf>

Runtime directory (XDG runtime), when available.

§temp: PathBuf

Temporary directory.

Trait Implementations§

Source§

impl Clone for PlatformDirs

Source§

fn clone(&self) -> PlatformDirs

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlatformDirs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PlatformDirs

Source§

impl PartialEq for PlatformDirs

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PlatformDirs

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.