[][src]Struct ido::config::PROJECT_DIRS

pub struct PROJECT_DIRS { /* fields omitted */ }

Methods from Deref<Target = ProjectDirs>

pub fn project_path(&self) -> &Path[src]

Returns the project path fragment used to compute the project's cache/config/data directories. The value is derived from the ProjectDirs::from call and is platform-dependent.

pub fn cache_dir(&self) -> &Path[src]

Returns the path to the project's cache directory.

PlatformValueExample
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_\cacheC:\Users\Alice\AppData\Local\Foo Corp\Bar App\cache

pub fn config_dir(&self) -> &Path[src]

Returns the path to the project's config directory.

PlatformValueExample
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_\configC:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config

pub fn data_dir(&self) -> &Path[src]

Returns the path to the project's data directory.

PlatformValueExample
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_\dataC:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\data

pub fn data_local_dir(&self) -> &Path[src]

Returns the path to the project's local data directory.

PlatformValueExample
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_\dataC:\Users\Alice\AppData\Local\Foo Corp\Bar App\data

pub fn preference_dir(&self) -> &Path[src]

Returns the path to the project's preference directory.

PlatformValueExample
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_\configC:\Users\Alice\AppData\Roaming\Foo Corp\Bar App\config

pub fn runtime_dir(&self) -> Option<&Path>[src]

Returns the path to the project's runtime directory.

PlatformValueExample
Linux$XDG_RUNTIME_DIR/_project_path_/run/user/1001/barapp
macOS
Windows

Trait Implementations

impl Deref for PROJECT_DIRS[src]

type Target = ProjectDirs

The resulting type after dereferencing.

impl LazyStatic for PROJECT_DIRS[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Erased for T

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> With for T

impl<T> With for T[src]