Struct unidirs::LocalDirs

pub struct LocalDirs { /* private fields */ }

Local directories are meant mostly for debug purposes while developing an application. By default it provides all available directories under a .local folder in the current working directory.

An alternative base directory can be provided with the LocalDirs::new_at function.

The folders are defined as follows, with <base> being either .local or a user defined directory:

Type	Location
Cache	<base>/cache
Config	<base>/config
Data	<base>/data

Implementations

impl LocalDirs

pub fn new() -> Option<Self>

Create a default instance, using the $PWD/.local directory as a base.

Examples

use std::env;
use unidirs::{Directories, LocalDirs};

let dirs = LocalDirs::new().unwrap();

assert_eq!(env::current_dir().unwrap().join(".local/data"), dirs.data_dir());

pub fn new_at(base: impl AsRef<Utf8Path>) -> Self

Create an instance at the given base directory.

Examples

use tempfile::TempDir;
use unidirs::{Directories, LocalDirs, Utf8Path};

let temp = TempDir::new().unwrap();
let dirs = LocalDirs::new_at(Utf8Path::from_path(temp.path()).unwrap());

assert_eq!(temp.path().join("data"), dirs.data_dir());

Trait Implementations

impl Clone for LocalDirs

fn clone(&self) -> LocalDirs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalDirs

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

Formats the value using the given formatter.

impl Directories for LocalDirs

fn cache_dir(&self) -> &Utf8Path

The cache directory is a location where an application can save any temporary data. The contents can potentially be deleted by the system at any time. Therefore, the application must be able to work without these files or be able to re-create them.

fn config_dir(&self) -> &Utf8Path

The config directory is where an application’s settings are stored. These are usually created by the user and loaded once at startup of the application.

fn data_dir(&self) -> &Utf8Path

The data directory hold an application’s state data, like a database. The folder is expected to persist during the normal runtime of the OS.

impl Hash for LocalDirs

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 LocalDirs

fn cmp(&self, other: &LocalDirs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<LocalDirs> for LocalDirs

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<LocalDirs> for LocalDirs

fn partial_cmp(&self, other: &LocalDirs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for LocalDirs

impl StructuralEq for LocalDirs

impl StructuralPartialEq for LocalDirs