File: C:/Ruby27-x64/share/doc/ruby/html/Resolv/IPv6.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Resolv::IPv6 - 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="../Object.html">Object</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-c-create">::create</a>
<li ><a href="#method-i-to_name">#to_name</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Resolv::IPv6">
<h1 id="class-Resolv::IPv6" class="class">
class Resolv::IPv6
</h1>
<section class="description">
<p>A <a href="DNS.html"><code>Resolv::DNS</code></a> <a href="IPv6.html"><code>IPv6</code></a> address.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="Regex">Regex
<dd><p>A composite <a href="IPv6.html"><code>IPv6</code></a> address <a href="../Regexp.html"><code>Regexp</code></a>.</p>
<dt id="Regex_6Hex4Dec">Regex_6Hex4Dec
<dd><p><a href="IPv4.html"><code>IPv4</code></a> mapped <a href="IPv6.html"><code>IPv6</code></a> address format a:b:c:d:e:f:w.x.y.z</p>
<dt id="Regex_8Hex">Regex_8Hex
<dd><p><a href="IPv6.html"><code>IPv6</code></a> address format a:b:c:d:e:f:g:h</p>
<dt id="Regex_CompressedHex">Regex_CompressedHex
<dd><p>Compressed <a href="IPv6.html"><code>IPv6</code></a> address format a::b</p>
<dt id="Regex_CompressedHex4Dec">Regex_CompressedHex4Dec
<dd><p>Compressed <a href="IPv4.html"><code>IPv4</code></a> mapped <a href="IPv6.html"><code>IPv6</code></a> address format a::b:w.x.y.z</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-address" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">address</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The raw <a href="IPv6.html"><code>IPv6</code></a> address as a <a href="../String.html"><code>String</code></a>.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-create" class="method-detail ">
<div class="method-heading">
<span class="method-name">create</span><span
class="method-args">(arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="IPv6.html"><code>IPv6</code></a> address from <code>arg</code> which may be:</p>
<dl class="rdoc-list note-list"><dt><a href="IPv6.html"><code>IPv6</code></a>
<dd>
<p>returns <code>arg</code>.</p>
</dd><dt><a href="../String.html"><code>String</code></a>
<dd>
<p><code>arg</code> must match one of the IPv6::Regex* constants</p>
</dd></dl>
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 2476</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">arg</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">IPv6</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">arg</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">address</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">b</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">Regex_8Hex</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">arg</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">address</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Regex_CompressedHex</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">arg</span>
<span class="ruby-identifier">prefix</span> = <span class="ruby-node">$1</span>
<span class="ruby-identifier">suffix</span> = <span class="ruby-node">$2</span>
<span class="ruby-identifier">a1</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">b</span>
<span class="ruby-identifier">a2</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">b</span>
<span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a1</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-identifier">suffix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a2</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-identifier">omitlen</span> = <span class="ruby-value">16</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">a1</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">a2</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">address</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a1</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">omitlen</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a2</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Regex_6Hex4Dec</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">arg</span>
<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>, <span class="ruby-identifier">c</span>, <span class="ruby-identifier">d</span> = <span class="ruby-node">$1</span>, <span class="ruby-node">$2</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$3</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$4</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$5</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">if</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">a</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">b</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">d</span>
<span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">address</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-identifier">address</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>, <span class="ruby-identifier">c</span>, <span class="ruby-identifier">d</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'CCCC'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"not numeric IPv6 address: "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Regex_CompressedHex4Dec</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">arg</span>
<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">suffix</span>, <span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>, <span class="ruby-identifier">c</span>, <span class="ruby-identifier">d</span> = <span class="ruby-node">$1</span>, <span class="ruby-node">$2</span>, <span class="ruby-node">$3</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$4</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$5</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-node">$6</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">if</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">a</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">b</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">&&</span> (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">255</span>) <span class="ruby-operator">===</span> <span class="ruby-identifier">d</span>
<span class="ruby-identifier">a1</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">b</span>
<span class="ruby-identifier">a2</span> = <span class="ruby-string">''</span>.<span class="ruby-identifier">b</span>
<span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a1</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-identifier">suffix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/[0-9A-Fa-f]+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">hex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a2</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'n'</span>)}
<span class="ruby-identifier">omitlen</span> = <span class="ruby-value">12</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">a1</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">a2</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">address</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a1</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">omitlen</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a2</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>, <span class="ruby-identifier">c</span>, <span class="ruby-identifier">d</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-string">'CCCC'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"not numeric IPv6 address: "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"not numeric IPv6 address: "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">IPv6</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">address</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"cannot interpret as IPv6 address: #{arg.inspect}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-to_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Turns this <a href="IPv6.html"><code>IPv6</code></a> address into a <a href="DNS/Name.html"><code>Resolv::DNS::Name</code></a>.</p>
<div class="method-source-code" id="to_name-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 2551</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_name</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">new</span>(
<span class="ruby-ivar">@address</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">"H32"</span>)[<span class="ruby-value">0</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp">//</span>).<span class="ruby-identifier">reverse</span> <span class="ruby-operator">+</span> [<span class="ruby-string">'ip6'</span>, <span class="ruby-string">'arpa'</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>