File: C:/Ruby27-x64/share/doc/ruby/html/StopIteration.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class StopIteration - 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="IndexError.html">IndexError</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-result">#result</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-StopIteration">
<h1 id="class-StopIteration" class="class">
class StopIteration
</h1>
<section class="description">
<p>Raised to stop the iteration, in particular by <a href="Enumerator.html#method-i-next"><code>Enumerator#next</code></a>. It is rescued by <a href="Kernel.html#method-i-loop"><code>Kernel#loop</code></a>.</p>
<pre class="ruby"><span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"Hello"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">StopIteration</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"World"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"Done!"</span>
</pre>
<p><em>produces:</em></p>
<pre class="ruby"><span class="ruby-constant">Hello</span>
<span class="ruby-identifier">Done!</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-result" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
result → value
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the return value of the iterator.</p>
<pre class="ruby"><span class="ruby-identifier">o</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">o</span>.<span class="ruby-identifier">each</span>
<span class="ruby-keyword">yield</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">yield</span> <span class="ruby-value">2</span>
<span class="ruby-keyword">yield</span> <span class="ruby-value">3</span>
<span class="ruby-value">100</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">e</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_enum</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">next</span> <span class="ruby-comment">#=> 1</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">next</span> <span class="ruby-comment">#=> 2</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">next</span> <span class="ruby-comment">#=> 3</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">e</span>.<span class="ruby-identifier">next</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StopIteration</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">result</span> <span class="ruby-comment">#=> 100</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="result-source">
<pre>static VALUE
stop_result(VALUE self)
{
return rb_attr_get(self, id_result);
}</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>