File: C:/Ruby27-x64/share/doc/ruby/html/Net/IMAP/NumValidator.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Net::IMAP::NumValidator - 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-ensure_mod_sequence_value">::ensure_mod_sequence_value</a>
<li ><a href="#method-c-ensure_number">::ensure_number</a>
<li ><a href="#method-c-ensure_nz_number">::ensure_nz_number</a>
<li ><a href="#method-c-valid_mod_sequence_value-3F">::valid_mod_sequence_value?</a>
<li ><a href="#method-c-valid_number-3F">::valid_number?</a>
<li ><a href="#method-c-valid_nz_number-3F">::valid_nz_number?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Net::IMAP::NumValidator">
<h1 id="module-Net::IMAP::NumValidator" class="module">
module Net::IMAP::NumValidator
</h1>
<section class="description">
<p>Common validators of number and nz_number types</p>
</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-ensure_mod_sequence_value" class="method-detail ">
<div class="method-heading">
<span class="method-name">ensure_mod_sequence_value</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ensure argument is 'mod_sequence_value' or raise <a href="DataFormatError.html"><code>DataFormatError</code></a></p>
<div class="method-source-code" id="ensure_mod_sequence_value-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1706</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ensure_mod_sequence_value</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">valid_mod_sequence_value?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-identifier">msg</span> = <span class="ruby-node">"mod_sequence_value must be unsigned 64-bit integer: #{num}"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">DataFormatError</span>, <span class="ruby-identifier">msg</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-ensure_number" class="method-detail ">
<div class="method-heading">
<span class="method-name">ensure_number</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ensure argument is 'number' or raise <a href="DataFormatError.html"><code>DataFormatError</code></a></p>
<div class="method-source-code" id="ensure_number-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1690</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ensure_number</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">valid_number?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-identifier">msg</span> = <span class="ruby-node">"number must be unsigned 32-bit integer: #{num}"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">DataFormatError</span>, <span class="ruby-identifier">msg</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-ensure_nz_number" class="method-detail ">
<div class="method-heading">
<span class="method-name">ensure_nz_number</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ensure argument is 'nz_number' or raise <a href="DataFormatError.html"><code>DataFormatError</code></a></p>
<div class="method-source-code" id="ensure_nz_number-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1698</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ensure_nz_number</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">valid_nz_number?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-identifier">msg</span> = <span class="ruby-node">"nz_number must be non-zero unsigned 32-bit integer: #{num}"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">DataFormatError</span>, <span class="ruby-identifier">msg</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-valid_mod_sequence_value-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid_mod_sequence_value?</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Check is passed argument valid 'mod_sequence_value' in RFC 4551 terminology</p>
<div class="method-source-code" id="valid_mod_sequence_value-3F-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1681</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid_mod_sequence_value?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-comment"># mod-sequence-value = 1*DIGIT</span>
<span class="ruby-comment"># ; Positive unsigned 64-bit integer</span>
<span class="ruby-comment"># ; (mod-sequence)</span>
<span class="ruby-comment"># ; (1 <= n < 18,446,744,073,709,551,615)</span>
<span class="ruby-identifier">num</span> <span class="ruby-operator">>=</span> <span class="ruby-value">1</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">num</span> <span class="ruby-operator"><</span> <span class="ruby-value">18446744073709551615</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-valid_number-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid_number?</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Check is passed argument valid 'number' in RFC 3501 terminology</p>
<div class="method-source-code" id="valid_number-3F-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1663</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid_number?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-comment"># [RFC 3501]</span>
<span class="ruby-comment"># number = 1*DIGIT</span>
<span class="ruby-comment"># ; Unsigned 32-bit integer</span>
<span class="ruby-comment"># ; (0 <= n < 4,294,967,296)</span>
<span class="ruby-identifier">num</span> <span class="ruby-operator">>=</span> <span class="ruby-value">0</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">num</span> <span class="ruby-operator"><</span> <span class="ruby-value">4294967296</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-valid_nz_number-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid_nz_number?</span><span
class="method-args">(num)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Check is passed argument valid 'nz_number' in RFC 3501 terminology</p>
<div class="method-source-code" id="valid_nz_number-3F-source">
<pre><span class="ruby-comment"># File lib/net/imap.rb, line 1672</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid_nz_number?</span>(<span class="ruby-identifier">num</span>)
<span class="ruby-comment"># [RFC 3501]</span>
<span class="ruby-comment"># nz-number = digit-nz *DIGIT</span>
<span class="ruby-comment"># ; Non-zero unsigned 32-bit integer</span>
<span class="ruby-comment"># ; (0 < n < 4,294,967,296)</span>
<span class="ruby-identifier">num</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid_number?</span>(<span class="ruby-identifier">num</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>