devela::all

Trait AppEnv

Source 
pub trait AppEnv {

Show 13 methods    // Required methods
    fn app_home(&self) -> &Path ⓘ;
    fn app_config(&self) -> PathBuf ⓘ;
    fn app_data(&self) -> PathBuf ⓘ;
    fn app_cache(&self) -> PathBuf ⓘ;
    fn app_state(&self) -> Option<PathBuf> ⓘ;
    fn app_runtime(&self) -> Option<PathBuf> ⓘ;

    // Provided methods
    fn app_in_config(&self, append: &Path) -> PathBuf ⓘ { ... }
    fn app_in_data(&self, append: &Path) -> PathBuf ⓘ { ... }
    fn app_in_cache(&self, append: &Path) -> PathBuf ⓘ { ... }
    fn app_in_state(&self, append: &Path) -> Option<PathBuf> ⓘ { ... }
    fn app_in_runtime(&self, append: &Path) -> Option<PathBuf> ⓘ { ... }
    fn app_temp(&self) -> PathBuf ⓘ { ... }
    fn app_in_temp(&self, append: &Path) -> PathBuf ⓘ { ... }

}
Available on crate feature std only.
Expand description

Manages directory paths in an environment-aware manner.

§Vendored

This is adapted work from etcetera.

Required Methods§

Source

fn app_home(&self) -> &Path ⓘ

Gets the home directory.

Source

fn app_config(&self) -> PathBuf ⓘ

Gets the configuration directory.

Source

fn app_data(&self) -> PathBuf ⓘ

Gets the data directory.

Source

fn app_cache(&self) -> PathBuf ⓘ

Gets the cache directory.

Source

fn app_state(&self) -> Option<PathBuf> ⓘ

Gets the state directory.

Currently, only the Xdg & AppUnix environments support this.

Source

fn app_runtime(&self) -> Option<PathBuf> ⓘ

Gets the runtime directory.

Currently, only the Xdg & AppUnix environments support this.

Note: The XDG Base Directory Specification places additional requirements on this directory related to ownership, permissions, and persistence. This implementation does not check those requirements.

Provided Methods§

Source

fn app_in_config(&self, append: &Path) -> PathBuf ⓘ

Constructs a path inside your application’s configuration directory.

Source

fn app_in_data(&self, append: &Path) -> PathBuf ⓘ

Constructs a path inside your application’s data directory.

Source

fn app_in_cache(&self, append: &Path) -> PathBuf ⓘ

Constructs a path inside your application’s cache directory.

Source

fn app_in_state(&self, append: &Path) -> Option<PathBuf> ⓘ

Constructs a path inside your application’s state directory.

Currently, only the Xdg & AppUnix environments support this.

Source

fn app_in_runtime(&self, append: &Path) -> Option<PathBuf> ⓘ

Constructs a path inside your application’s runtime directory.

Currently, only the Xdg & AppUnix environments support this.

Source

fn app_temp(&self) -> PathBuf ⓘ

Gets the temporary directory.

Uses the system’s temporary directory if available. Falls back to the application cache directory if the temporary directory is unsuitable.

Source

fn app_in_temp(&self, append: &Path) -> PathBuf ⓘ

Constructs a path inside the temporary directory.

Implementors§