|
|
<!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` crate."><meta name="keywords" content="rust, rustlang, rust-lang, walkdir"><title>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 mod"><!--[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'>Crate walkdir</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all walkdir's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'walkdir', ty: 'mod', relpath: '../'};</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#1-1725' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>walkdir</a></span></h1><div class='docblock'><p>Crate <code>walkdir</code> provides an efficient and cross platform implementation
|
|
|
of recursive directory traversal. Several options are exposed to control
|
|
|
iteration, such as whether to follow symbolic links (default off), limit the
|
|
|
maximum number of simultaneous open file descriptors and the ability to
|
|
|
efficiently skip descending into directories.</p>
|
|
|
<p>To use this crate, add <code>walkdir</code> as a dependency to your project's
|
|
|
<code>Cargo.toml</code>:</p>
|
|
|
<pre><code class="language-toml">[dependencies]
|
|
|
walkdir = "2"
|
|
|
</code></pre>
|
|
|
<h1 id="from-the-top" class="section-header"><a href="#from-the-top">From the top</a></h1>
|
|
|
<p>The <a href="struct.WalkDir.html"><code>WalkDir</code></a> type builds iterators. The <a href="struct.DirEntry.html"><code>DirEntry</code></a> type describes values
|
|
|
yielded by the iterator. Finally, the <a href="struct.Error.html"><code>Error</code></a> type is a small wrapper around
|
|
|
<a href="https://doc.rust-lang.org/stable/std/io/struct.Error.html"><code>std::io::Error</code></a> with additional information, such as if a loop was detected
|
|
|
while following symbolic links (not enabled by default).</p>
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
<p>The following code recursively iterates over the directory given and prints
|
|
|
the path for each entry:</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="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>Or, if you'd like to iterate over all entries and ignore any errors that
|
|
|
may arise, use <a href="https://doc.rust-lang.org/stable/std/iter/trait.Iterator.html#method.filter_map"><code>filter_map</code></a>. (e.g., This code below will silently skip
|
|
|
directories that the owner of the running process does not have permission to
|
|
|
access.)</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">into_iter</span>().<span class="ident">filter_map</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">e</span>.<span class="ident">ok</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>());
|
|
|
}</pre></div>
|
|
|
<h1 id="example-follow-symbolic-links" class="section-header"><a href="#example-follow-symbolic-links">Example: follow symbolic links</a></h1>
|
|
|
<p>The same code as above, except <a href="struct.WalkDir.html#method.follow_links"><code>follow_links</code></a> is 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">follow_links</span>(<span class="bool-val">true</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>
|
|
|
<h1 id="example-skip-hidden-files-and-directories-on-unix" class="section-header"><a href="#example-skip-hidden-files-and-directories-on-unix">Example: skip hidden files and directories on unix</a></h1>
|
|
|
<p>This uses the <a href="struct.IntoIter.html#method.filter_entry"><code>filter_entry</code></a> iterator adapter to avoid yielding hidden files
|
|
|
and directories efficiently (i.e. without recursing into hidden directories):</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">walkdir</span>::{<span class="ident">DirEntry</span>, <span class="ident">WalkDir</span>};
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">is_hidden</span>(<span class="ident">entry</span>: <span class="kw-2">&</span><span class="ident">DirEntry</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
|
|
|
<span class="ident">entry</span>.<span class="ident">file_name</span>()
|
|
|
.<span class="ident">to_str</span>()
|
|
|
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">starts_with</span>(<span class="string">"."</span>))
|
|
|
.<span class="ident">unwrap_or</span>(<span class="bool-val">false</span>)
|
|
|
}
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">walker</span> <span class="op">=</span> <span class="ident">WalkDir</span>::<span class="ident">new</span>(<span class="string">"foo"</span>).<span class="ident">into_iter</span>();
|
|
|
<span class="kw">for</span> <span class="ident">entry</span> <span class="kw">in</span> <span class="ident">walker</span>.<span class="ident">filter_entry</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="op">!</span><span class="ident">is_hidden</span>(<span class="ident">e</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>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.DirEntry.html" title='walkdir::DirEntry struct'>DirEntry</a></td><td class='docblock-short'><p>A directory entry.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Error.html" title='walkdir::Error struct'>Error</a></td><td class='docblock-short'><p>An error produced by recursively walking a directory.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FilterEntry.html" title='walkdir::FilterEntry struct'>FilterEntry</a></td><td class='docblock-short'><p>A recursive directory iterator that skips entries.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IntoIter.html" title='walkdir::IntoIter struct'>IntoIter</a></td><td class='docblock-short'><p>An iterator for recursively descending into a directory.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WalkDir.html" title='walkdir::WalkDir struct'>WalkDir</a></td><td class='docblock-short'><p>A builder to create an iterator for recursively walking a directory.</p>
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.DirEntryExt.html" title='walkdir::DirEntryExt trait'>DirEntryExt</a></td><td class='docblock-short'><p>Unix-specific extension methods for <code>walkdir::DirEntry</code></p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='walkdir::Result type'>Result</a></td><td class='docblock-short'><p>A result type for walkdir operations.</p>
|
|
|
</td></tr></table></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> |
