File: C:/Ruby27-x64/share/doc/ruby/html/Find.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Find - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-find">::find</a>
<li ><a href="#method-c-prune">::prune</a>
<li ><a href="#method-i-find">#find</a>
<li ><a href="#method-i-prune">#prune</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Find">
<h1 id="module-Find" class="module">
module Find
</h1>
<section class="description">
<p>The <code>Find</code> module supports the top-down traversal of a set of file paths.</p>
<p>For example, to total the size of all files under your home directory, ignoring anything in a “dot” directory (e.g. $HOME/.ssh):</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'find'</span>
<span class="ruby-identifier">total_size</span> = <span class="ruby-value">0</span>
<span class="ruby-constant">Find</span>.<span class="ruby-identifier">find</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">"HOME"</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>).<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'.'</span>)
<span class="ruby-constant">Find</span>.<span class="ruby-identifier">prune</span> <span class="ruby-comment"># Don't look any further into this directory.</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">total_size</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-find" class="method-detail ">
<div class="method-heading">
<span class="method-name">find</span><span
class="method-args">(*paths, ignore_error: true) { |path| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls the associated block with the name of every file and directory listed as arguments, then recursively on their subdirectories, and so on.</p>
<p>Returns an enumerator if no block is given.</p>
<p>See the <code>Find</code> module documentation for an example.</p>
<div class="method-source-code" id="find-source">
<pre><span class="ruby-comment"># File lib/find.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">paths</span>, <span class="ruby-value">ignore_error:</span> <span class="ruby-keyword">true</span>) <span class="ruby-comment"># :yield: path</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">paths</span>, <span class="ruby-value">ignore_error:</span> <span class="ruby-identifier">ignore_error</span>)
<span class="ruby-identifier">fs_encoding</span> = <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">find</span>(<span class="ruby-string">"filesystem"</span>)
<span class="ruby-identifier">paths</span>.<span class="ruby-identifier">collect!</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-identifier">d</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">d</span>); <span class="ruby-identifier">d</span>.<span class="ruby-identifier">dup</span>}.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_path</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:to_path</span>
<span class="ruby-identifier">enc</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">US_ASCII</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">fs_encoding</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">encoding</span>
<span class="ruby-identifier">ps</span> = [<span class="ruby-identifier">path</span>]
<span class="ruby-keyword">while</span> <span class="ruby-identifier">file</span> = <span class="ruby-identifier">ps</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">catch</span>(<span class="ruby-value">:prune</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">s</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">lstat</span>(<span class="ruby-identifier">file</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EACCES</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTDIR</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ELOOP</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENAMETOOLONG</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ignore_error</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">fs</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">children</span>(<span class="ruby-identifier">file</span>, <span class="ruby-value">encoding:</span> <span class="ruby-identifier">enc</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EACCES</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTDIR</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ELOOP</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENAMETOOLONG</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ignore_error</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">fs</span>.<span class="ruby-identifier">sort!</span>
<span class="ruby-identifier">fs</span>.<span class="ruby-identifier">reverse_each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">f</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">f</span>)
<span class="ruby-identifier">ps</span>.<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">f</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-prune" class="method-detail ">
<div class="method-heading">
<span class="method-name">prune</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Skips the current file or directory, restarting the loop with the next entry. If the current file is a directory, that directory will not be recursively entered. Meaningful only within the block associated with <a href="Find.html#method-c-find"><code>Find::find</code></a>.</p>
<p>See the <code>Find</code> module documentation for an example.</p>
<div class="method-source-code" id="prune-source">
<pre><span class="ruby-comment"># File lib/find.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prune</span>
<span class="ruby-identifier">throw</span> <span class="ruby-value">:prune</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-find" class="method-detail ">
<div class="method-heading">
<span class="method-name">find</span><span
class="method-args">(*paths, ignore_error: true) { |path| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls the associated block with the name of every file and directory listed as arguments, then recursively on their subdirectories, and so on.</p>
<p>Returns an enumerator if no block is given.</p>
<p>See the <code>Find</code> module documentation for an example.</p>
<div class="method-source-code" id="find-source">
<pre><span class="ruby-comment"># File lib/find.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">paths</span>, <span class="ruby-value">ignore_error:</span> <span class="ruby-keyword">true</span>) <span class="ruby-comment"># :yield: path</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">paths</span>, <span class="ruby-value">ignore_error:</span> <span class="ruby-identifier">ignore_error</span>)
<span class="ruby-identifier">fs_encoding</span> = <span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">find</span>(<span class="ruby-string">"filesystem"</span>)
<span class="ruby-identifier">paths</span>.<span class="ruby-identifier">collect!</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-identifier">d</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">d</span>); <span class="ruby-identifier">d</span>.<span class="ruby-identifier">dup</span>}.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_path</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:to_path</span>
<span class="ruby-identifier">enc</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">US_ASCII</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">fs_encoding</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">encoding</span>
<span class="ruby-identifier">ps</span> = [<span class="ruby-identifier">path</span>]
<span class="ruby-keyword">while</span> <span class="ruby-identifier">file</span> = <span class="ruby-identifier">ps</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">catch</span>(<span class="ruby-value">:prune</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">s</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">lstat</span>(<span class="ruby-identifier">file</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EACCES</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTDIR</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ELOOP</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENAMETOOLONG</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ignore_error</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">fs</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">children</span>(<span class="ruby-identifier">file</span>, <span class="ruby-value">encoding:</span> <span class="ruby-identifier">enc</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EACCES</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTDIR</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ELOOP</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENAMETOOLONG</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ignore_error</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">fs</span>.<span class="ruby-identifier">sort!</span>
<span class="ruby-identifier">fs</span>.<span class="ruby-identifier">reverse_each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">f</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">f</span>)
<span class="ruby-identifier">ps</span>.<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">f</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prune" class="method-detail ">
<div class="method-heading">
<span class="method-name">prune</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Skips the current file or directory, restarting the loop with the next entry. If the current file is a directory, that directory will not be recursively entered. Meaningful only within the block associated with <a href="Find.html#method-c-find"><code>Find::find</code></a>.</p>
<p>See the <code>Find</code> module documentation for an example.</p>
<div class="method-source-code" id="prune-source">
<pre><span class="ruby-comment"># File lib/find.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prune</span>
<span class="ruby-identifier">throw</span> <span class="ruby-value">:prune</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>