Trait BaseStrategy

Source

pub trait BaseStrategy {
    // Required methods
    fn home_dir(&self) -> &Path;
    fn config_dir(&self) -> PathBuf;
    fn data_dir(&self) -> PathBuf;
    fn cache_dir(&self) -> PathBuf;
    fn state_dir(&self) -> Option<PathBuf>;
    fn runtime_dir(&self) -> Option<PathBuf>;
}

Expand description

Provides configuration, data, and cache directories of the current user.

Required Methods§

Source

fn home_dir(&self) -> &Path

Gets the home directory of the current user.

Source

fn config_dir(&self) -> PathBuf

Gets the user’s configuration directory.

Source

fn data_dir(&self) -> PathBuf

Gets the user’s data directory.

Source

fn cache_dir(&self) -> PathBuf

Gets the user’s cache directory.

Source

fn state_dir(&self) -> Option<PathBuf>

Gets the user’s state directory. Currently, only the Xdg strategy supports this.

Source

fn runtime_dir(&self) -> Option<PathBuf>

Gets the user’s runtime directory. Currently, only the Xdg strategy supports this.

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