|
|
|
|
|
<!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 `WalkDir` struct in crate `walkdir`."><meta name="keywords" content="rust, rustlang, rust-lang, WalkDir"><title>walkdir::WalkDir - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../walkdir/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct WalkDir</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.contents_first">contents_first</a><a href="#method.follow_links">follow_links</a><a href="#method.max_depth">max_depth</a><a href="#method.max_open">max_open</a><a href="#method.min_depth">min_depth</a><a href="#method.new">new</a><a href="#method.same_file_system">same_file_system</a><a href="#method.sort_by">sort_by</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-IntoIterator">IntoIterator</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><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><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><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-IntoIterator">IntoIterator</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='index.html'>walkdir</a></p><script>window.sidebarCurrent = {name: 'WalkDir', 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"><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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/walkdir/lib.rs.html#245-248' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>walkdir</a>::<wbr><a class="struct" href=''>WalkDir</a></span></h1><div class="docblock type-decl hid
|
|
|
|
|
|
<p>Results are returned in depth first fashion, with directories yielded
|
|
|
|
|
|
before their contents. If <a href="struct.WalkDir.html#method.contents_first"><code>contents_first</code></a> is true, contents are yielded
|
|
|
|
|
|
before their directories. The order is unspecified but if <a href="struct.WalkDir.html#method.sort_by"><code>sort_by</code></a> is
|
|
|
|
|
|
given, directory entries are sorted according to this function. Directory
|
|
|
|
|
|
entries <code>.</code> and <code>..</code> are always omitted.</p>
|
|
|
|
|
|
<p>If an error occurs at any point during iteration, then it is returned in
|
|
|
|
|
|
place of its corresponding directory entry and iteration continues as
|
|
|
|
|
|
normal. If an error occurs while opening a directory for reading, then it
|
|
|
|
|
|
is not descended into (but the error is still yielded by the iterator).
|
|
|
|
|
|
Iteration may be stopped at any time. When the iterator is destroyed, all
|
|
|
|
|
|
resources associated with it are freed.</p>
|
|
|
|
|
|
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
|
|
|
|
|
<p>This type implements <a href="https://doc.rust-lang.org/stable/std/iter/trait.IntoIterator.html"><code>IntoIterator</code></a> so that it may be used as the subject
|
|
|
|
|
|
of a <code>for</code> loop. You may need to call <a href="https://doc.rust-lang.org/nightly/core/iter/trait.IntoIterator.html#tymethod.into_iter"><code>into_iter</code></a> explicitly if you want
|
|
|
|
|
|
to use iterator adapters such as <a href="struct.IntoIter.html#method.filter_entry"><code>filter_entry</code></a>.</p>
|
|
|
|
|
|
<p>Idiomatic use of this type should use method chaining to set desired
|
|
|
|
|
|
options. For example, this only shows entries with a depth of <code>1</code>, <code>2</code> or
|
|
|
|
|
|
<code>3</code> (relative to <code>foo</code>):</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::<span class="ident">WalkDir</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">entry</span> <span class="kw">in</span> <span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>).<span class="ident">min_depth</span>(<span class="number">1</span>).<span class="ident">max_depth</span>(<span class="number">3</span>) {
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">entry</span><span class="question-mark">?</span>.<span class="ident">path</span>().<span class="ident">display</span>());
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
<p>Note that the iterator by default includes the top-most directory. Since
|
|
|
|
|
|
this is the only directory yielded with depth <code>0</code>, it is easy to ignore it
|
|
|
|
|
|
with the <a href="struct.WalkDir.html#method.min_depth"><code>min_depth</code></a> setting:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::<span class="ident">WalkDir</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">entry</span> <span class="kw">in</span> <span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>).<span class="ident">min_depth</span>(<span class="number">1</span>) {
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">entry</span><span class="question-mark">?</span>.<span class="ident">path</span>().<span class="ident">display</span>());
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
<p>This will only return descendents of the <code>foo</code> directory and not <code>foo</code>
|
|
|
|
|
|
itself.</p>
|
|
|
|
|
|
<h1 id="loops" class="section-header"><a href="#loops">Loops</a></h1>
|
|
|
|
|
|
<p>This iterator (like most/all recursive directory iterators) assumes that
|
|
|
|
|
|
no loops can be made with <em>hard</em> links on your file system. In particular,
|
|
|
|
|
|
this would require creating a hard link to a directory such that it creates
|
|
|
|
|
|
a loop. On most platforms, this operation is illegal.</p>
|
|
|
|
|
|
<p>Note that when following symbolic/soft links, loops are detected and an
|
|
|
|
|
|
error is reported.</p>
|
|
|
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/walkdir/lib.rs.html#282-478' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(root: P) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#290-303' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a builder for a recursive directory iterator starting at the
|
|
|
|
|
|
file path <code>root</code>. If <code>root</code> is a directory, then it is the first item
|
|
|
|
|
|
yielded by the iterator. If <code>root</code> is a file, then it is the first
|
|
|
|
|
|
and only item yielded by the iterator. If <code>root</code> is a symlink, then it
|
|
|
|
|
|
is always followed for the purposes of directory traversal. (A root
|
|
|
|
|
|
<code>DirEntry</code> still obeys its documentation with respect to symlinks and
|
|
|
|
|
|
the <code>follow_links</code> setting.)</p>
|
|
|
|
|
|
</div><h4 id='method.min_depth' class="method"><code id='min_depth.v'>pub fn <a href='#method.min_depth' class='fnname'>min_depth</a>(self, depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#310-316' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set the minimum depth of entries yielded by the iterator.</p>
|
|
|
|
|
|
<p>The smallest depth is <code>0</code> and always corresponds to the path given
|
|
|
|
|
|
to the <code>new</code> function on this type. Its direct descendents have depth
|
|
|
|
|
|
<code>1</code>, and their descendents have depth <code>2</code>, and so on.</p>
|
|
|
|
|
|
</div><h4 id='method.max_depth' class="method"><code id='max_depth.v'>pub fn <a href='#method.max_depth' class='fnname'>max_depth</a>(self, depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#327-333' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set the maximum depth of entries yield by the iterator.</p>
|
|
|
|
|
|
<p>The smallest depth is <code>0</code> and always corresponds to the path given
|
|
|
|
|
|
to the <code>new</code> function on this type. Its direct descendents have depth
|
|
|
|
|
|
<code>1</code>, and their descendents have depth <code>2</code>, and so on.</p>
|
|
|
|
|
|
<p>Note that this will not simply filter the entries of the iterator, but
|
|
|
|
|
|
it will actually avoid descending into directories when the depth is
|
|
|
|
|
|
exceeded.</p>
|
|
|
|
|
|
</div><h4 id='method.follow_links' class="method"><code id='follow_links.v'>pub fn <a href='#method.follow_links' class='fnname'>follow_links</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#346-349' title='goto source code'>[src]</a></h4><div class='docblock'><p>Follow symbolic links. By default, this is disabled.</p>
|
|
|
|
|
|
<p>When <code>yes</code> is <code>true</code>, symbolic links are followed as if they were
|
|
|
|
|
|
normal directories and files. If a symbolic link is broken or is
|
|
|
|
|
|
involved in a loop, an error is yielded.</p>
|
|
|
|
|
|
<p>When enabled, the yielded <a href="struct.DirEntry.html"><code>DirEntry</code></a> values represent the target of
|
|
|
|
|
|
the link while the path corresponds to the link. See the <a href="struct.DirEntry.html"><code>DirEntry</code></a>
|
|
|
|
|
|
type for more details.</p>
|
|
|
|
|
|
</div><h4 id='method.max_open' class="method"><code id='max_open.v'>pub fn <a href='#method.max_open' class='fnname'>max_open</a>(self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#376-382' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set the maximum number of simultaneously open file descriptors used
|
|
|
|
|
|
by the iterator.</p>
|
|
|
|
|
|
<p><code>n</code> must be greater than or equal to <code>1</code>. If <code>n</code> is <code>0</code>, then it is set
|
|
|
|
|
|
to <code>1</code> automatically. If this is not set, then it defaults to some
|
|
|
|
|
|
reasonably low number.</p>
|
|
|
|
|
|
<p>This setting has no impact on the results yielded by the iterator
|
|
|
|
|
|
(even when <code>n</code> is <code>1</code>). Instead, this setting represents a trade off
|
|
|
|
|
|
between scarce resources (file descriptors) and memory. Namely, when
|
|
|
|
|
|
the maximum number of file descriptors is reached and a new directory
|
|
|
|
|
|
needs to be opened to continue iteration, then a previous directory
|
|
|
|
|
|
handle is closed and has its unyielded entries stored in memory. In
|
|
|
|
|
|
practice, this is a satisfying trade off because it scales with respect
|
|
|
|
|
|
to the <em>depth</em> of your file tree. Therefore, low values (even <code>1</code>) are
|
|
|
|
|
|
acceptable.</p>
|
|
|
|
|
|
<p>Note that this value does not impact the number of system calls made by
|
|
|
|
|
|
an exhausted iterator.</p>
|
|
|
|
|
|
<h1 id="platform-behavior" class="section-header"><a href="#platform-behavior">Platform behavior</a></h1>
|
|
|
|
|
|
<p>On Windows, if <code>follow_links</code> is enabled, then this limit is not
|
|
|
|
|
|
respected. In particular, the maximum number of file descriptors opened
|
|
|
|
|
|
is proportional to the depth of the directory tree traversed.</p>
|
|
|
|
|
|
</div><h4 id='method.sort_by' class="method"><code id='sort_by.v'>pub fn <a href='#method.sort_by' class='fnname'>sort_by</a><F>(self, cmp: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../walkdir/struct.DirEntry.html" title="struct walkdir::DirEntry">DirEntry</a>, &<a class="struct" href="../walkdir/struct.DirEntry.html" title="struct walkdir::DirEntry">DirEntry</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code><a class='srclink' href='../src/walkdir/lib.rs.html#397-402' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set a function for sorting directory entries.</p>
|
|
|
|
|
|
<p>If a compare function is set, the resulting iterator will return all
|
|
|
|
|
|
paths in sorted order. The compare function will be called to compare
|
|
|
|
|
|
entries from the same directory.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">cmp</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">OsString</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::<span class="ident">WalkDir</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>).<span class="ident">sort_by</span>(<span class="op">|</span><span class="ident">a</span>,<span class="ident">b</span><span class="op">|</span> <span class="ident">a</span>.<span class="ident">file_name</span>().<span class="ident">cmp</span>(<span class="ident">b</span>.<span class="ident">file_name</span>()));</pre></div>
|
|
|
|
|
|
</div><h4 id='method.contents_first' class="method"><code id='contents_first.v'>pub fn <a href='#method.contents_first' class='fnname'>contents_first</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#461-464' title='goto source code'>[src]</a></h4><div class='docblock'><p>Yield a directory's contents before the directory itself. By default,
|
|
|
|
|
|
this is disabled.</p>
|
|
|
|
|
|
<p>When <code>yes</code> is <code>false</code> (as is the default), the directory is yielded
|
|
|
|
|
|
before its contents are read. This is useful when, e.g. you want to
|
|
|
|
|
|
skip processing of some directories.</p>
|
|
|
|
|
|
<p>When <code>yes</code> is <code>true</code>, the iterator yields the contents of a directory
|
|
|
|
|
|
before yielding the directory itself. This is useful when, e.g. you
|
|
|
|
|
|
want to recursively delete a directory.</p>
|
|
|
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
|
|
|
<p>Assume the following directory tree:</p>
|
|
|
|
|
|
<pre><code class="language-text">foo/
|
|
|
|
|
|
abc/
|
|
|
|
|
|
qrs
|
|
|
|
|
|
tuv
|
|
|
|
|
|
def/
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
<p>With contents_first disabled (the default), the following code visits
|
|
|
|
|
|
the directory tree in depth-first order:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::<span class="ident">WalkDir</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">entry</span> <span class="kw">in</span> <span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>) {
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">entry</span>.<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">entry</span>.<span class="ident">path</span>().<span class="ident">display</span>());
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// foo</span>
|
|
|
|
|
|
<span class="comment">// foo/abc</span>
|
|
|
|
|
|
<span class="comment">// foo/abc/qrs</span>
|
|
|
|
|
|
<span class="comment">// foo/abc/tuv</span>
|
|
|
|
|
|
<span class="comment">// foo/def</span></pre></div>
|
|
|
|
|
|
<p>With contents_first enabled:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::<span class="ident">WalkDir</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">entry</span> <span class="kw">in</span> <span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>).<span class="ident">contents_first</span>(<span class="bool-val">true</span>) {
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">entry</span>.<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">entry</span>.<span class="ident">path</span>().<span class="ident">display</span>());
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// foo/abc/qrs</span>
|
|
|
|
|
|
<span class="comment">// foo/abc/tuv</span>
|
|
|
|
|
|
<span class="comment">// foo/abc</span>
|
|
|
|
|
|
<span class="comment">// foo/def</span>
|
|
|
|
|
|
<span class="comment">// foo</span></pre></div>
|
|
|
|
|
|
</div><h4 id='method.same_file_system' class="method"><code id='same_file_system.v'>pub fn <a href='#method.same_file_system' class='fnname'>same_file_system</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class='srclink' href='../src/walkdir/lib.rs.html#474-477' title='goto source code'>[src]</a></h4><div class='docblock'><p>Do not cross file system boundaries.</p>
|
|
|
|
|
|
<p>When this option is enabled, directory traversal will not descend into
|
|
|
|
|
|
directories that are on a different file system from the root path.</p>
|
|
|
|
|
|
<p>Currently, this option is only supported on Unix and Windows. If this
|
|
|
|
|
|
option is used on an unsupported platform, then directory traversal
|
|
|
|
|
|
will immediately return an error and will not yield any entries.</p>
|
|
|
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-IntoIterator' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-IntoIterator' class='anchor'></a><a class='srclink' href='../src/walkdir/lib.rs.html#480-496' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><code id='Item.t'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="type" href="../walkdir/type.Result.html" title="type walkdir::Result">Result</a><<a class="struct" href="../walkdir/struct.DirEntry.html" title="struct walkdir::DirEntry">DirEntry</a>></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
|
|
|
|
|
</div><h4 id='associatedtype.IntoIter' class="type"><code id='IntoIter.t'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../walkdir/struct.IntoIter.html" title="struct walkdir::IntoIter">IntoIter</a></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
|
|
|
|
|
</div><h4 id='method.into_iter' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../walkdir/struct.IntoIter.html" title="struct walkdir::IntoIter">IntoIter</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../walkdir/struct.IntoIter.html" title="struct walkdir::IntoIter">IntoIter</a></h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../walkdir/struct.IntoIter.html" title="struct walkdir::IntoIter">IntoIter</a></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="type" href="../walkdir/type.Result.html" title="type walkdir::Result">Result</a><<a class="struct" href="../walkdir/struct.DirEntry.html" title="struct walkdir::DirEntry">DirEntry</a>>;</span></code></div></div><code id='into_iter.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> <a class="struct" href="../walkdir/struct.IntoIter.html" title="struct walkdir::IntoIter">IntoIter</a></code><a class='srclink' href='../src/walkdir/lib.rs.html#484-495' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>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="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/walkdir/lib.rs.html#244' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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><a class='srclink' href='../src/walkdir/lib.rs.html#244' title='goto source code'>[src]</a></h4><div class='docblock hidden'><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></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'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../walkdir/struct.WalkDir.html" title="struct walkdir::WalkDir">WalkDir</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></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'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-IntoIterator-1' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>, </span></code><a href='#impl-IntoIterator-1' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#242-249' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><code id='Item.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
|
|
|
|
|
</div><h4 id='associatedtype.IntoIter-1' class="type"><code id='IntoIter.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = I</code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
|
|
|
|
|
</div><h4 id='method.into_iter-1' class="method hidden"><code id='into_iter.v-1'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> I</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#246-248' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
|
|
|
</div></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "walkdir";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
