Struct Windows 

pub struct Windows { /* private fields */ }

This strategy follows Windows’ conventions. It seems that all Windows GUI apps, and some command-line ones follow this pattern. The specification is available here.

This initial example removes all the relevant environment variables to show the strategy’s use of the:

• (on Windows) SHGetKnownFolderPath API.
• (on non-Windows) Windows default directories.

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

// Remove the environment variables that the strategy reads from.
unsafe {
std::env::remove_var("USERPROFILE");
std::env::remove_var("APPDATA");
std::env::remove_var("LOCALAPPDATA");
}

let app_strategy = Windows::new(AppStrategyArgs {
    top_level_domain: "org".to_string(),
    author: "Acme Corp".to_string(),
    app_name: "Frobnicator Plus".to_string(),
}).unwrap();

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

assert_eq!(
    app_strategy.home_dir(),
    &home_dir
);
assert_eq!(
    app_strategy.config_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Roaming/Acme Corp/Frobnicator Plus/config"))
);
assert_eq!(
    app_strategy.data_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Roaming/Acme Corp/Frobnicator Plus/data"))
);
assert_eq!(
    app_strategy.cache_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Local/Acme Corp/Frobnicator Plus/cache"))
);
assert_eq!(
    app_strategy.state_dir(),
    None
);
assert_eq!(
    app_strategy.runtime_dir(),
    None
);

This next example gives the environment variables values:

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

let home_path = if cfg!(windows) {
    "C:\\my_home_location\\".to_string()
} else {
    etcetera::home_dir().unwrap().to_string_lossy().to_string()
};
let data_path = if cfg!(windows) {
    "C:\\my_data_location\\"
} else {
    "/my_data_location/"
};
let cache_path = if cfg!(windows) {
    "C:\\my_cache_location\\"
} else {
    "/my_cache_location/"
};

unsafe {
std::env::set_var("USERPROFILE", &home_path);
std::env::set_var("APPDATA", data_path);
std::env::set_var("LOCALAPPDATA", cache_path);
}

let app_strategy = Windows::new(AppStrategyArgs {
    top_level_domain: "org".to_string(),
    author: "Acme Corp".to_string(),
    app_name: "Frobnicator Plus".to_string(),
}).unwrap();

assert_eq!(
    app_strategy.home_dir(),
    Path::new(&home_path)
);
assert_eq!(
    app_strategy.config_dir(),
    Path::new(&format!("{}/Acme Corp/Frobnicator Plus/config", data_path))
);
assert_eq!(
    app_strategy.data_dir(),
    Path::new(&format!("{}/Acme Corp/Frobnicator Plus/data", data_path))
);
assert_eq!(
    app_strategy.cache_dir(),
    Path::new(&format!("{}/Acme Corp/Frobnicator Plus/cache", cache_path))
);
assert_eq!(
    app_strategy.state_dir(),
    None
);
assert_eq!(
    app_strategy.runtime_dir(),
    None
);

Implementations

impl Windows

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

Create a new Windows AppStrategy

Trait Implementations

impl AppStrategy for Windows

fn home_dir(&self) -> &Path

Gets the home directory of the current user.

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 state_dir(&self) -> Option<PathBuf>

Gets the state directory for your application. Currently, only the Xdg & Unix strategies support this.

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

Gets the runtime directory for your application. Currently, only the Xdg & Unix strategies support this.

fn in_config_dir<P: AsRef<OsStr>>(&self, path: P) -> PathBuf

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

fn in_data_dir<P: AsRef<OsStr>>(&self, path: P) -> PathBuf

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

fn in_cache_dir<P: AsRef<OsStr>>(&self, path: P) -> PathBuf

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

fn in_state_dir<P: AsRef<OsStr>>(&self, path: P) -> Option<PathBuf>

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

fn in_runtime_dir<P: AsRef<OsStr>>(&self, path: P) -> Option<PathBuf>

Constructs a path inside your application’s runtime directory to which a path of your choice has been appended. Currently, only the Xdg & Unix strategies support this.

impl Clone for Windows

fn clone(&self) -> Windows

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Windows

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

Formats the value using the given formatter.

impl Hash for Windows

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 Windows

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

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

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

impl StructuralPartialEq for Windows