File: C:/Ruby27-x64/share/doc/ruby/html/Rinda/Template.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rinda::Template - 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="Tuple.html">Rinda::Tuple</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-3D-3D-3D">#===</a>
<li ><a href="#method-i-match">#match</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rinda::Template">
<h1 id="class-Rinda::Template" class="class">
class Rinda::Template
</h1>
<section class="description">
<p>Templates are used to match tuples in <a href="../Rinda.html"><code>Rinda</code></a>.</p>
</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-3D-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">===</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Alias for <a href="Template.html#method-i-match"><code>match</code></a>.</p>
<div class="method-source-code" id="3D-3D-3D-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">===</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">match</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-match" class="method-detail ">
<div class="method-heading">
<span class="method-name">match</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Matches this template against <code>tuple</code>. The <code>tuple</code> must be the same size as the template. An element with a <code>nil</code> value in a template acts as a wildcard, matching any value in the corresponding position in the tuple. Elements of the template match the <code>tuple</code> if the are #== or <a href="Template.html#method-i-3D-3D-3D"><code>===</code></a>.</p>
<pre class="ruby"><span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">5</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">5</span>]) <span class="ruby-comment"># => true</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-keyword">nil</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">5</span>]) <span class="ruby-comment"># => true</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-constant">String</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-string">'hello'</span>]) <span class="ruby-comment"># => true</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">5</span>]) <span class="ruby-comment"># => false</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">6</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">5</span>]) <span class="ruby-comment"># => false</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-keyword">nil</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>]) <span class="ruby-comment"># => false</span>
<span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>, <span class="ruby-value">6</span>]).<span class="ruby-identifier">match</span> <span class="ruby-constant">Tuple</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">:foo</span>]) <span class="ruby-comment"># => false</span>
</pre>
<div class="method-source-code" id="match-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 148</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:size</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:fetch</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">it</span> = <span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">k</span>)
<span class="ruby-keyword">rescue</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">it</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">it</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</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>