233 lines
No EOL
20 KiB
HTML
233 lines
No EOL
20 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 `DirEntry` struct in crate `tokio_fs`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, DirEntry">
|
||
|
||
<title>tokio_fs::DirEntry - Rust</title>
|
||
|
||
<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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Struct DirEntry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.into_std">into_std</a><a href="#method.path">path</a><a href="#method.file_name">file_name</a><a href="#method.poll_metadata">poll_metadata</a><a href="#method.poll_file_type">poll_file_type</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-DirEntryExt">DirEntryExt</a></div></div><p class='location'><a href='index.html'>tokio_fs</a></p><script>window.sidebarCurrent = {name: 'DirEntry', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<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'>Struct <a href='index.html'>tokio_fs</a>::<wbr><a class="struct" href=''>DirEntry</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/tokio_fs/read_dir.rs.html#101' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct DirEntry(_);</pre><div class='docblock'><p>Entries returned by the <a href="struct.ReadDir.html"><code>ReadDir</code></a> stream.</p>
|
||
<p>This is a specialized version of <a href="https://doc.rust-lang.org/std/fs/struct.DirEntry.html"><code>std::fs::DirEntry</code></a> for usage from the
|
||
Tokio runtime.</p>
|
||
<p>An instance of <code>DirEntry</code> represents an entry inside of a directory on the
|
||
filesystem. Each entry can be inspected via methods to learn about the full
|
||
path or possibly other metadata through per-platform extension traits.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../tokio_fs/struct.DirEntry.html" title="struct tokio_fs::DirEntry">DirEntry</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#103-240' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.into_std' class="method"><span id='into_std.v' class='invisible'><code>pub fn <a href='#method.into_std' class='fnname'>into_std</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.DirEntry.html" title="struct std::fs::DirEntry">StdDirEntry</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#107-109' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Destructures the <code>tokio_fs::DirEntry</code> into a <a href="https://doc.rust-lang.org/std/fs/struct.DirEntry.html"><code>std::fs::DirEntry</code></a>.</p>
|
||
</div><h4 id='method.path' class="method"><span id='path.v' class='invisible'><code>pub fn <a href='#method.path' class='fnname'>path</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#142-144' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the full path to the file that this entry represents.</p>
|
||
<p>The full path is created by joining the original path to <code>read_dir</code>
|
||
with the filename of this entry.</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">futures</span>::{<span class="ident">Future</span>, <span class="ident">Stream</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">tokio_fs</span>::<span class="ident">read_dir</span>(<span class="string">"."</span>).<span class="ident">flatten_stream</span>().<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">dir</span><span class="op">|</span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">dir</span>.<span class="ident">path</span>());
|
||
<span class="prelude-val">Ok</span>(())
|
||
}).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> { <span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"Error: {:?}"</span>, <span class="ident">err</span>); () });
|
||
<span class="ident">tokio</span>::<span class="ident">run</span>(<span class="ident">fut</span>);
|
||
}</pre>
|
||
<p>This prints output like:</p>
|
||
<pre><code class="language-text">"./whatever.txt"
|
||
"./foo.html"
|
||
"./hello_world.rs"
|
||
</code></pre>
|
||
<p>The exact text, of course, depends on what files you have in <code>.</code>.</p>
|
||
</div><h4 id='method.file_name' class="method"><span id='file_name.v' class='invisible'><code>pub fn <a href='#method.file_name' class='fnname'>file_name</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#166-168' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the bare file name of this directory entry without any other
|
||
leading path component.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Future</span>, <span class="ident">Stream</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">tokio_fs</span>::<span class="ident">read_dir</span>(<span class="string">"."</span>).<span class="ident">flatten_stream</span>().<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">dir</span><span class="op">|</span> {
|
||
<span class="comment">// Here, `dir` is a `DirEntry`.</span>
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">dir</span>.<span class="ident">file_name</span>());
|
||
<span class="prelude-val">Ok</span>(())
|
||
}).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> { <span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"Error: {:?}"</span>, <span class="ident">err</span>); () });
|
||
<span class="ident">tokio</span>::<span class="ident">run</span>(<span class="ident">fut</span>);
|
||
}</pre>
|
||
</div><h4 id='method.poll_metadata' class="method"><span id='poll_metadata.v' class='invisible'><code>pub fn <a href='#method.poll_metadata' class='fnname'>poll_metadata</a>(&self) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.Metadata.html" title="struct std::fs::Metadata">Metadata</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#201-203' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the metadata for the file that this entry points at.</p>
|
||
<p>This function will not traverse symlinks if this entry points at a
|
||
symlink.</p>
|
||
<h1 id="platform-specific-behavior" class="section-header"><a href="#platform-specific-behavior">Platform-specific behavior</a></h1>
|
||
<p>On Windows this function is cheap to call (no extra system calls
|
||
needed), but on Unix platforms this function is the equivalent of
|
||
calling <code>symlink_metadata</code> on the path.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Future</span>, <span class="ident">Stream</span>};
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">poll_fn</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">tokio_fs</span>::<span class="ident">read_dir</span>(<span class="string">"."</span>).<span class="ident">flatten_stream</span>().<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">dir</span><span class="op">|</span> {
|
||
<span class="comment">// Here, `dir` is a `DirEntry`.</span>
|
||
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">dir</span>.<span class="ident">path</span>();
|
||
<span class="ident">poll_fn</span>(<span class="kw">move</span> <span class="op">||</span> <span class="ident">dir</span>.<span class="ident">poll_metadata</span>()).<span class="ident">map</span>(<span class="kw">move</span> <span class="op">|</span><span class="ident">metadata</span><span class="op">|</span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}: {:?}"</span>, <span class="ident">path</span>, <span class="ident">metadata</span>.<span class="ident">permissions</span>());
|
||
})
|
||
}).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> { <span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"Error: {:?}"</span>, <span class="ident">err</span>); () });
|
||
<span class="ident">tokio</span>::<span class="ident">run</span>(<span class="ident">fut</span>);
|
||
}</pre>
|
||
</div><h4 id='method.poll_file_type' class="method"><span id='poll_file_type.v' class='invisible'><code>pub fn <a href='#method.poll_file_type' class='fnname'>poll_file_type</a>(&self) -> <a class="type" href="../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.FileType.html" title="struct std::fs::FileType">FileType</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#237-239' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the file type for the file that this entry points at.</p>
|
||
<p>This function will not traverse symlinks if this entry points at a
|
||
symlink.</p>
|
||
<h1 id="platform-specific-behavior-1" class="section-header"><a href="#platform-specific-behavior-1">Platform-specific behavior</a></h1>
|
||
<p>On Windows and most Unix platforms this function is free (no extra
|
||
system calls needed), but some Unix platforms may require the equivalent
|
||
call to <code>symlink_metadata</code> to learn about the target file type.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Future</span>, <span class="ident">Stream</span>};
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">poll_fn</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">tokio_fs</span>::<span class="ident">read_dir</span>(<span class="string">"."</span>).<span class="ident">flatten_stream</span>().<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">dir</span><span class="op">|</span> {
|
||
<span class="comment">// Here, `dir` is a `DirEntry`.</span>
|
||
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">dir</span>.<span class="ident">path</span>();
|
||
<span class="ident">poll_fn</span>(<span class="kw">move</span> <span class="op">||</span> <span class="ident">dir</span>.<span class="ident">poll_file_type</span>()).<span class="ident">map</span>(<span class="kw">move</span> <span class="op">|</span><span class="ident">file_type</span><span class="op">|</span> {
|
||
<span class="comment">// Now let's show our entry's file type!</span>
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}: {:?}"</span>, <span class="ident">path</span>, <span class="ident">file_type</span>);
|
||
})
|
||
}).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> { <span class="macro">eprintln</span><span class="macro">!</span>(<span class="string">"Error: {:?}"</span>, <span class="ident">err</span>); () });
|
||
<span class="ident">tokio</span>::<span class="ident">run</span>(<span class="ident">fut</span>);
|
||
}</pre>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../tokio_fs/struct.DirEntry.html" title="struct tokio_fs::DirEntry">DirEntry</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#100' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#100' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-DirEntryExt' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/fs/trait.DirEntryExt.html" title="trait std::sys::unix::ext::fs::DirEntryExt">DirEntryExt</a> for <a class="struct" href="../tokio_fs/struct.DirEntry.html" title="struct tokio_fs::DirEntry">DirEntry</a></code><a href='#impl-DirEntryExt' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#243-247' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.ino' class="method"><span id='ino.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/fs/trait.DirEntryExt.html#tymethod.ino' class='fnname'>ino</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_fs/read_dir.rs.html#244-246' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the underlying <code>d_ino</code> field in the contained <code>dirent</code> structure. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/fs/trait.DirEntryExt.html#tymethod.ino">Read more</a></p>
|
||
</div></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><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse 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 = "tokio_fs";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |