| <!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 `mkdir` fn in crate `nix`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, mkdir"> |
| |
| <title>nix::unistd::mkdir - Rust</title> |
| |
| <link rel="stylesheet" type="text/css" href="../../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> |
| <link rel="stylesheet" type="text/css" href="../../main.css"> |
| |
| |
| |
| |
| </head> |
| <body class="rustdoc fn"> |
| <!--[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'>nix</a>::<wbr><a href='index.html'>unistd</a></p><script>window.sidebarCurrent = {name: 'mkdir', ty: 'fn', 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"> |
| <h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>nix</a>::<wbr><a href='index.html'>unistd</a>::<wbr><a class="fn" href=''>mkdir</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 class='srclink' href='../../src/nix/unistd.rs.html#300-306' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust fn'>pub fn mkdir<P: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../nix/trait.NixPath.html" title="trait nix::NixPath">NixPath</a>>(path: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>P, mode: <a class="struct" href="../../nix/sys/stat/struct.Mode.html" title="struct nix::sys::stat::Mode">Mode</a>) -> <a class="type" href="../../nix/type.Result.html" title="type nix::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></pre><div class='docblock'><p>Creates new directory <code>path</code> with access rights <code>mode</code>.</p> |
| |
| <h1 id='errors' class='section-header'><a href='#errors'>Errors</a></h1> |
| <p>There are several situations where mkdir might fail:</p> |
| |
| <ul> |
| <li>current user has insufficient rights in the parent directory</li> |
| <li>the path already exists</li> |
| <li>the path name is too long (longer than <code>PATH_MAX</code>, usually 4096 on linux, 1024 on OS X)</li> |
| </ul> |
| |
| <p>For a full list consult |
| <a href="http://man7.org/linux/man-pages/man2/mkdir.2.html#ERRORS">man mkdir(2)</a></p> |
| |
| <h1 id='example' class='section-header'><a href='#example'>Example</a></h1> |
| <pre class="rust rust-example-rendered"> |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tempdir</span>; |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">nix</span>; |
| |
| <span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">unistd</span>; |
| <span class="kw">use</span> <span class="ident">nix</span>::<span class="ident">sys</span>::<span class="ident">stat</span>; |
| <span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>; |
| |
| <span class="kw">fn</span> <span class="ident">main</span>() { |
| <span class="kw">let</span> <span class="ident">tmp_dir1</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new</span>(<span class="string">"test_mkdir"</span>).<span class="ident">unwrap</span>(); |
| <span class="kw">let</span> <span class="ident">tmp_dir2</span> <span class="op">=</span> <span class="ident">tmp_dir1</span>.<span class="ident">path</span>().<span class="ident">join</span>(<span class="string">"new_dir"</span>); |
| |
| <span class="comment">// create new directory and give read, write and execute rights to the owner</span> |
| <span class="kw">match</span> <span class="ident">unistd</span>::<span class="ident">mkdir</span>(<span class="kw-2">&</span><span class="ident">tmp_dir2</span>, <span class="ident">stat</span>::<span class="ident">S_IRWXU</span>) { |
| <span class="prelude-val">Ok</span>(_) <span class="op">=></span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"created {:?}"</span>, <span class="ident">tmp_dir2</span>), |
| <span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"Error creating directory: {}"</span>, <span class="ident">err</span>), |
| } |
| }</pre> |
| </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> |
| <dt>+</dt> |
| <dd>Collapse/expand all sections</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 = "nix"; |
| </script> |
| <script src="../../main.js"></script> |
| <script defer src="../../search-index.js"></script> |
| </body> |
| </html> |