# Function bitflags::__core::env::home_dir [−] [src]

    pub fn home_dir() -> Option<PathBuf>

1.0.0

Returns the path of the current user's home directory if known.

# Unix

Returns the value of the 'HOME' environment variable if it is set and not equal to the empty string. Otherwise, it tries to determine the home directory by invoking the `getpwuid_r` function on the UID of the current user.

# Windows

Returns the value of the 'HOME' environment variable if it is set and not equal to the empty string. Otherwise, returns the value of the 'USERPROFILE' environment variable if it is set and not equal to the empty string. If both do not exist, `GetUserProfileDirectory` is used to return the appropriate path.

# Examples

    use std::env;

    match env::home_dir() {
        Some(path) => println!("{}", path.display()),
        None => println!("Impossible to get your home dir!"),
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)