Struct AppUnix

pub struct AppUnix { /* private fields */ }

Available on crate feature std only.

Unix enviroment for directories.

This constructs directories specific to an application using its unixy_name, which is derived from the application’s name.

This is no standard or official specification, but an old convention of placing the configuration directory under the user’s home directory.

Vim and Cargo are notable examples whose configuration/data/cache directory layouts are similar to these.

Implementations

impl AppUnix

pub fn new(app_data: AppConfig) -> Option<Self>

Creates a new Unix directory environment.

Returns None if the home directory cannot be determined (see Env::home_dir),

Trait Implementations

impl AppEnv for AppUnix

fn app_home(&self) -> &Path

Gets the home directory.

fn app_config(&self) -> PathBuf

Gets the configuration directory.

fn app_data(&self) -> PathBuf

Gets the data directory.

fn app_cache(&self) -> PathBuf

Gets the cache directory.

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

Gets the state directory.

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

Gets the runtime directory.

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

Constructs a path inside your application’s configuration directory.

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

Constructs a path inside your application’s data directory.

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

Constructs a path inside your application’s cache directory.

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

Constructs a path inside your application’s state directory.

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

Constructs a path inside your application’s runtime directory.

fn app_temp(&self) -> PathBuf

Gets the temporary directory.

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

Constructs a path inside the temporary directory.

impl Clone for AppUnix

fn clone(&self) -> AppUnix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppUnix

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

Formats the value using the given formatter.

impl Hash for AppUnix

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 AppUnix

fn cmp(&self, other: &AppUnix) -> 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 AppUnix

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

fn partial_cmp(&self, other: &AppUnix) -> 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 Eq for AppUnix

impl StructuralPartialEq for AppUnix