Struct etcetera::app_strategy::Unix

pub struct Unix { /* fields omitted */ }

This strategy has no standard or official specification. It has arisen over time through hundreds of Unixy tools. Vim and Cargo are notable examples whose configuration/data/cache directory layouts are similar to those created by this strategy.

use etcetera::app_strategy::AppStrategy;
use etcetera::app_strategy::AppStrategyArgs;
use etcetera::app_strategy::Unix;
use std::path::Path;

let app_strategy = Unix::new(AppStrategyArgs {
    top_level_domain: "org".to_string(),
    author: "Bram Moolenar".to_string(),
    app_name: "Vim".to_string(),
}).unwrap();

let home_dir = etcetera::home_dir().unwrap();

assert_eq!(
    app_strategy.config_dir().strip_prefix(&home_dir),
    Ok(Path::new(".vim/")
));
assert_eq!(
    app_strategy.data_dir().strip_prefix(&home_dir),
    Ok(Path::new(".vim/data/")
));
assert_eq!(
    app_strategy.cache_dir().strip_prefix(&home_dir),
    Ok(Path::new(".vim/cache/")
));

Trait Implementations

impl AppStrategy for Unix

type CreationError = HomeDirError

The error type returned by new.

fn new(args: AppStrategyArgs) -> Result<Self, Self::CreationError>

The constructor requires access to some basic information about your application.

fn config_dir(&self) -> PathBuf

Gets the configuration directory for your application.

fn data_dir(&self) -> PathBuf

Gets the data directory for your application.

fn cache_dir(&self) -> PathBuf

Gets the cache directory for your application.

fn config_file<FileName: AsRef<OsStr>>(&self, file_name: FileName) -> PathBuf

Constructs a path inside your application’s configuration directory to which a file name of your choice has been appended.

fn data_file<FileName: AsRef<OsStr>>(&self, file_name: FileName) -> PathBuf

Constructs a path inside your application’s data directory to which a file name of your choice has been appended.

fn cache_file<FileName: AsRef<OsStr>>(&self, file_name: FileName) -> PathBuf

Constructs a path inside your application’s cache directory to which a file name of your choice has been appended.

impl Debug for Unix

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

Formats the value using the given formatter.