111 lines
41 KiB
HTML
111 lines
41 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="`BaseDirs` provides paths of user-invisible standard directories, following the conventions of the operating system the library is running on."><meta name="keywords" content="rust, rustlang, rust-lang, BaseDirs"><title>BaseDirs in directories - 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 struct"><!--[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="../directories/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Struct BaseDirs</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.cache_dir">cache_dir</a><a href="#method.config_dir">config_dir</a><a href="#method.data_dir">data_dir</a><a href="#method.data_local_dir">data_local_dir</a><a href="#method.executable_dir">executable_dir</a><a href="#method.home_dir">home_dir</a><a href="#method.new">new</a><a href="#method.preference_dir">preference_dir</a><a href="#method.runtime_dir">runtime_dir</a><a href="#method.state_dir">state_dir</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="index.html">directories</a></h2><div id="sidebar-vars" data-name="BaseDirs" data-ty="struct" 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="../directories/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">Struct <a href="index.html">directories</a>::<wbr><a class="struct" href="#">BaseDirs</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/directories/lib.rs.html#63-76" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct BaseDirs { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>BaseDirs</code> provides paths of user-invisible standard directories, following the conventions of the operating system the library is running on.</p>
|
||
<p>To compute the location of cache, config or data directories for individual projects or applications, use <code>ProjectDirs</code> instead.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<p>All examples on this page are computed with a user named <em>Alice</em>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">directories::BaseDirs</span>;
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">base_dirs</span>) <span class="op">=</span> <span class="ident">BaseDirs::new</span>() {
|
||
<span class="ident">base_dirs</span>.<span class="ident">config_dir</span>();
|
||
<span class="comment">// Linux: /home/alice/.config</span>
|
||
<span class="comment">// Windows: C:\Users\Alice\AppData\Roaming</span>
|
||
<span class="comment">// macOS: /Users/Alice/Library/Application Support</span>
|
||
}</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#142-267" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#168-170" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> <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="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a>></h4></div></summary><div class="docblock"><p>Creates a <code>BaseDirs</code> struct which holds the paths to user-invisible directories for cache, config, etc. data on the system.</p>
|
||
<p>The returned value depends on the operating system and is either</p>
|
||
<ul>
|
||
<li><code>Some</code>, containing a snapshot of the state of the system’s paths at the time <code>new()</code> was invoked, or</li>
|
||
<li><code>None</code>, if no valid home directory path could be retrieved from the operating system.</li>
|
||
</ul>
|
||
<p>To determine whether a system provides a valid <code>$HOME</code> path, the following rules are applied:</p>
|
||
<h6 id="linux-and-macos" class="section-header"><a href="#linux-and-macos">Linux and macOS:</a></h6>
|
||
<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>
|
||
<h6 id="windows" class="section-header"><a href="#windows">Windows:</a></h6>
|
||
<ul>
|
||
<li>Retrieve the user profile folder using <code>SHGetKnownFolderPath</code>.</li>
|
||
<li>If this fails, then the function returns <code>None</code>.</li>
|
||
</ul>
|
||
<p><em>Note:</em> This logic 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><details class="rustdoc-toggle method-toggle" open><summary><div id="method.home_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#178-180" title="goto source code">[src]</a></div><a href="#method.home_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.home_dir" class="fnname">home_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s home directory.</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></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.cache_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#188-190" title="goto source code">[src]</a></div><a href="#method.cache_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.cache_dir" class="fnname">cache_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s cache directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_CACHE_HOME</code> or <code>$HOME</code>/.cache</td><td>/home/alice/.cache</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code>/Library/Caches</td><td>/Users/Alice/Library/Caches</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_LocalAppData}</code></td><td>C:\Users\Alice\AppData\Local</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.config_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#198-200" title="goto source code">[src]</a></div><a href="#method.config_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.config_dir" class="fnname">config_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s config directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_CONFIG_HOME</code> or <code>$HOME</code>/.config</td><td>/home/alice/.config</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code>/Library/Application Support</td><td>/Users/Alice/Library/Application Support</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_RoamingAppData}</code></td><td>C:\Users\Alice\AppData\Roaming</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.data_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#208-210" title="goto source code">[src]</a></div><a href="#method.data_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.data_dir" class="fnname">data_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s data directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_DATA_HOME</code> or <code>$HOME</code>/.local/share</td><td>/home/alice/.local/share</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code>/Library/Application Support</td><td>/Users/Alice/Library/Application Support</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_RoamingAppData}</code></td><td>C:\Users\Alice\AppData\Roaming</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.data_local_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#218-220" title="goto source code">[src]</a></div><a href="#method.data_local_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.data_local_dir" class="fnname">data_local_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s local data directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_DATA_HOME</code> or <code>$HOME</code>/.local/share</td><td>/home/alice/.local/share</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code>/Library/Application Support</td><td>/Users/Alice/Library/Application Support</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_LocalAppData}</code></td><td>C:\Users\Alice\AppData\Local</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.executable_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#228-230" title="goto source code">[src]</a></div><a href="#method.executable_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.executable_dir" class="fnname">executable_dir</a>(&self) -> <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.Path.html" title="struct std::path::Path">Path</a>></h4></div></summary><div class="docblock"><p>Returns the path to the user’s executable directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_BIN_HOME</code> or <code>$XDG_DATA_HOME</code>/../bin or <code>$HOME</code>/.local/bin</td><td>/home/alice/.local/bin</td></tr>
|
||
<tr><td>macOS</td><td>–</td><td>–</td></tr>
|
||
<tr><td>Windows</td><td>–</td><td>–</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.preference_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#238-240" title="goto source code">[src]</a></div><a href="#method.preference_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.preference_dir" class="fnname">preference_dir</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.59.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h4></div></summary><div class="docblock"><p>Returns the path to the user’s preference directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_CONFIG_HOME</code> or <code>$HOME</code>/.config</td><td>/home/alice/.config</td></tr>
|
||
<tr><td>macOS</td><td><code>$HOME</code>/Library/Preferences</td><td>/Users/Alice/Library/Preferences</td></tr>
|
||
<tr><td>Windows</td><td><code>{FOLDERID_RoamingAppData}</code></td><td>C:\Users\Alice\AppData\Roaming</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.runtime_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#248-250" title="goto source code">[src]</a></div><a href="#method.runtime_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.runtime_dir" class="fnname">runtime_dir</a>(&self) -> <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.Path.html" title="struct std::path::Path">Path</a>></h4></div></summary><div class="docblock"><p>Returns the path to the user’s runtime directory.</p>
|
||
<div><table><thead><tr><th>Platform</th><th>Value</th><th>Example</th></tr></thead><tbody>
|
||
<tr><td>Linux</td><td><code>$XDG_RUNTIME_DIR</code></td><td>/run/user/1001/</td></tr>
|
||
<tr><td>macOS</td><td>–</td><td>–</td></tr>
|
||
<tr><td>Windows</td><td>–</td><td>–</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.state_dir" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#264-266" title="goto source code">[src]</a></div><a href="#method.state_dir" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.state_dir" class="fnname">state_dir</a>(&self) -> <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.Path.html" title="struct std::path::Path">Path</a>></h4></div></summary><div class="docblock"><p>Returns the path to the user’s state directory.</p>
|
||
<p>The state directory contains data that should be retained between sessions (unlike the runtime
|
||
directory), but may not be important/portable enough to be synchronized across machines (unlike
|
||
the config/preferences/data directories).</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>$XDG_STATE_HOME</code> or <code>$HOME</code>/.local/state</td><td>/home/alice/.local/state</td></tr>
|
||
<tr><td>macOS</td><td>–</td><td>–</td></tr>
|
||
<tr><td>Windows</td><td>–</td><td>–</td></tr>
|
||
</tbody></table>
|
||
</div></div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Clone" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#62" title="goto source code">[src]</a></div><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#62" title="goto source code">[src]</a></div><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h4></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/clone.rs.html#130" title="goto source code">[src]</a></div><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>Self)</h4></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#62" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/directories/lib.rs.html#62" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.BaseDirs.html" title="struct directories::BaseDirs">BaseDirs</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToOwned" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#84-96" title="goto source code">[src]</a></div><a href="#impl-ToOwned" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Owned" class="type trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></div></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_owned" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#89" title="goto source code">[src]</a></div><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></div></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#93" title="goto source code">[src]</a></div><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T)</h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</div></div><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="directories" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |