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::base_strategy::BaseStrategy;
use etcetera::base_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 base_strategy = Windows::new().unwrap();

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

assert_eq!(
    base_strategy.home_dir(),
    &home_dir
);
assert_eq!(
    base_strategy.config_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Roaming/"))
);
assert_eq!(
    base_strategy.data_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Roaming/"))
);
assert_eq!(
    base_strategy.cache_dir().strip_prefix(&home_dir),
    Ok(Path::new("AppData/Local/"))
);
assert_eq!(
    base_strategy.state_dir(),
    None
);
assert_eq!(
    base_strategy.runtime_dir(),
    None
);

This next example gives the environment variables values:

use etcetera::base_strategy::BaseStrategy;
use etcetera::base_strategy::Windows;
use std::path::Path;

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

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

let base_strategy = Windows::new().unwrap();

assert_eq!(
    base_strategy.home_dir(),
    Path::new(&home_path)
);
assert_eq!(
    base_strategy.config_dir(),
    Path::new(data_path)
);
assert_eq!(
    base_strategy.data_dir(),
    Path::new(data_path)
);
assert_eq!(
    base_strategy.cache_dir(),
    Path::new(cache_path)
);
assert_eq!(
    base_strategy.state_dir(),
    None
);
assert_eq!(
    base_strategy.runtime_dir(),
    None
);

Implementations

impl Windows

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

Create a new Windows BaseStrategy

Trait Implementations

impl BaseStrategy for Windows

fn home_dir(&self) -> &Path

Gets the home directory of the current user.

fn config_dir(&self) -> PathBuf

Gets the user’s configuration directory.

fn data_dir(&self) -> PathBuf

Gets the user’s data directory.

fn cache_dir(&self) -> PathBuf

Gets the user’s cache directory.

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

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

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

Gets the user’s runtime directory. Currently, only the Xdg strategy supports 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