24 lines
6.1 KiB
HTML
24 lines
6.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Returns the path to the user’s home directory."><meta name="keywords" content="rust, rustlang, rust-lang, home_dir"><title>home_dir in dirs - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../dirs/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">dirs</a></h2><div id="sidebar-vars" data-name="home_dir" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../dirs/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Function <a href="index.html">dirs</a>::<wbr><a class="fn" href="#">home_dir</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/dirs/lib.rs.html#74-76" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust fn"><code>pub fn home_dir() -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the path to the user’s home directory.</p>
|
||
<p>The returned value depends on the operating system and is either a <code>Some</code>, containing a value from the following table, or a <code>None</code>.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$HOME</code></td><td>/home/alice</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code></td><td>/Users/Alice</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_Profile}</code></td><td>C:\Users\Alice</td></tr>
|
||
</tbody></table>
|
||
</div><h4 id="linux-and-macos" class="section-header"><a href="#linux-and-macos">Linux and macOS:</a></h4>
|
||
<ul>
|
||
<li>Use <code>$HOME</code> if it is set and not empty.</li>
|
||
<li>If <code>$HOME</code> is not set or empty, then the function <code>getpwuid_r</code> is used to determine
|
||
the home directory of the current user.</li>
|
||
<li>If <code>getpwuid_r</code> lacks an entry for the current user id or the home directory field is empty,
|
||
then the function returns <code>None</code>.</li>
|
||
</ul>
|
||
<h4 id="windows" class="section-header"><a href="#windows">Windows:</a></h4>
|
||
<p>This function retrieves the user profile folder using <code>SHGetKnownFolderPath</code>.</p>
|
||
<p>All the examples on this page mentioning <code>$HOME</code> use this behavior.</p>
|
||
<p><em>Note:</em> This function’s behavior differs from <a href="https://doc.rust-lang.org/std/env/fn.home_dir.html"><code>std::env::home_dir</code></a>,
|
||
which works incorrectly on Linux, macOS and Windows.</p>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="dirs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |