141 lines
No EOL
8.1 KiB
HTML
141 lines
No EOL
8.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="API documentation for the Rust `DirBuilder` struct in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, DirBuilder">
|
||
|
||
<title>bitflags::__core::fs::DirBuilder - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>fs</a></p><script>window.sidebarCurrent = {name: 'DirBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>fs</a>::<wbr><a class='struct' href=''>DirBuilder</a></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 id='src-3678' class='srclink' href='https://doc.rust-lang.org/nightly/std/fs/struct.DirBuilder.html?gotosrc=3678' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct DirBuilder {
|
||
// some fields omitted
|
||
}</pre><span class="since">1.6.0</span><div class='docblock'><p>A builder used to create directories in various manners.</p>
|
||
|
||
<p>This builder also supports platform-specific options.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../../../bitflags/__core/fs/struct.DirBuilder.html' title='bitflags::__core::fs::DirBuilder'>DirBuilder</a></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>() -> <a class='struct' href='../../../bitflags/__core/fs/struct.DirBuilder.html' title='bitflags::__core::fs::DirBuilder'>DirBuilder</a></code></h4>
|
||
<div class='docblock'><p>Creates a new set of options with default mode/security settings for all
|
||
platforms and also non-recursive.</p>
|
||
</div><h4 id='method.recursive' class='method'><code>fn <a href='#method.recursive' class='fnname'>recursive</a>(&mut self, recursive: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a>) -> &mut <a class='struct' href='../../../bitflags/__core/fs/struct.DirBuilder.html' title='bitflags::__core::fs::DirBuilder'>DirBuilder</a></code></h4>
|
||
<div class='docblock'><p>Indicate that directories create should be created recursively, creating
|
||
all parent directories if they do not exist with the same security and
|
||
permissions settings.</p>
|
||
|
||
<p>This option defaults to <code>false</code></p>
|
||
</div><h4 id='method.create' class='method'><code>fn <a href='#method.create' class='fnname'>create</a><P>(&self, path: P) -> <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.tuple.html'>()</a>, <a class='struct' href='../../../bitflags/__core/io/struct.Error.html' title='bitflags::__core::io::Error'>Error</a>> <span class='where'>where P: <a class='trait' href='../../../bitflags/__core/convert/trait.AsRef.html' title='bitflags::__core::convert::AsRef'>AsRef</a><<a class='struct' href='../../../bitflags/__core/path/struct.Path.html' title='bitflags::__core::path::Path'>Path</a>></span></code></h4>
|
||
<div class='docblock'><p>Create the specified directory with the options configured in this
|
||
builder.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fs</span>::{<span class='self'>self</span>, <span class='ident'>DirBuilder</span>};
|
||
|
||
<span class='kw'>let</span> <span class='ident'>path</span> <span class='op'>=</span> <span class='string'>"/tmp/foo/bar/baz"</span>;
|
||
<span class='ident'>DirBuilder</span>::<span class='ident'>new</span>()
|
||
.<span class='ident'>recursive</span>(<span class='boolval'>true</span>)
|
||
.<span class='ident'>create</span>(<span class='ident'>path</span>).<span class='ident'>unwrap</span>();
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>fs</span>::<span class='ident'>metadata</span>(<span class='ident'>path</span>).<span class='ident'>unwrap</span>().<span class='ident'>is_dir</span>());</pre>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='../../../bitflags/__core/os/ext/fs/trait.DirBuilderExt.html' title='bitflags::__core::os::ext::fs::DirBuilderExt'>DirBuilderExt</a> for <a class='struct' href='../../../bitflags/__core/fs/struct.DirBuilder.html' title='bitflags::__core::fs::DirBuilder'>DirBuilder</a></code></h3><div class='impl-items'><h4 id='method.mode' class='method'><code>fn <a href='../../../bitflags/__core/os/ext/fs/trait.DirBuilderExt.html#tymethod.mode' class='fnname'>mode</a>(&mut self, mode: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.u32.html'>u32</a>) -> &mut <a class='struct' href='../../../bitflags/__core/fs/struct.DirBuilder.html' title='bitflags::__core::fs::DirBuilder'>DirBuilder</a></code></h4>
|
||
</div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |