Crate homedir

source ·
Expand description

This crate exists to provide a portable method to getting any user’s home directory. The API is rather simple: there are two main functions, get_home and get_my_home. The former can get the home directory of any user provided you have their username. The latter can get the home directory of the user executing this process.

This crate aims to work on both Windows and Unix systems. However, Unix systems do not have a unified API. This crate may not work on Unix systems which do not have the getpwnam_r(3), getpwuid_r(3), and getuid(2) functions.

Usage

This crate is on crates.io and can be used by executing cargo add homedir or adding the following to the dependencies in your Cargo.toml file.

[dependencies]
homedir = "0.2.1"

Examples

Get the process’ user’s home directory.

use homedir::get_my_home;

// This assumes that the process' user has "/home/jpetersen" as home directory.
assert_eq!(
    std::path::Path::new("/home/jpetersen"),
    get_my_home().unwrap().unwrap().as_path()
);

Get an arbitrary user’s home directory.

use homedir::get_home;

// This assumes there is a user named `Administrator` which has
// `C:\Users\Administrator` as a home directory.
assert_eq!(
    std::path::Path::new("C:\\Users\\Administrator"),
    get_home("Administrator").unwrap().unwrap().as_path()
);
assert!(get_home("NonExistentUser").unwrap().is_none());

Note for users upgrading from version 0.1.0: On Unix systems, the previous behaviour of get_my_home was to check the /etc/passwd file first, then the $HOME variable if the check_env feature was set. This has been changed in this version. Instead, the $HOME environment variable is checked first, and then the /etc/passwd file. To emulate the old behaviour, use the unix::get_home_from_id alongside unix::get_my_id.

Unfortunately, on Windows, this crate currently brings on quite a few dependencies through the wmi, windows-sys, widestring, and serde crates. In the future, a newer version will most likely no longer require serde and wmi. However, for now, these are required.

Re-exports

Modules

  • unix
    Contains the implementation of the crate for Unix systems.