File: C:/Ruby27-x64/share/doc/ruby/html/Resolv/DNS/Name.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Resolv::DNS::Name - 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-absolute-3F">#absolute?</a>
<li ><a href="#method-i-subdomain_of-3F">#subdomain_of?</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Resolv::DNS::Name">
<h1 id="class-Resolv::DNS::Name" class="class">
class Resolv::DNS::Name
</h1>
<section class="description">
<p>A representation of a <a href="../DNS.html"><code>DNS</code></a> name.</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-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="../DNS.html"><code>DNS</code></a> name from <code>arg</code>. <code>arg</code> can be:</p>
<dl class="rdoc-list note-list"><dt><a href="Name.html"><code>Name</code></a>
<dd>
<p>returns <code>arg</code>.</p>
</dd><dt><a href="../../String.html"><code>String</code></a>
<dd>
<p>Creates a new <a href="Name.html"><code>Name</code></a>.</p>
</dd></dl>
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 1240</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">Name</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-keyword">return</span> <span class="ruby-constant">Name</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Label</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">arg</span>), <span class="ruby-regexp">/\.\z/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">arg</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</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 DNS name: #{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-absolute-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">absolute?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True if this name is absolute.</p>
<div class="method-source-code" id="absolute-3F-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 1271</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">absolute?</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@absolute</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subdomain_of-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">subdomain_of?</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if <code>other</code> is a subdomain.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">domain</span> = <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"y.z"</span>)
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"w.x.y.z"</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"x.y.z"</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> true</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"y.z"</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"z"</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"x.y.z."</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"w.z"</span>).<span class="ruby-identifier">subdomain_of?</span>(<span class="ruby-identifier">domain</span>) <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="subdomain_of-3F-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 1297</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subdomain_of?</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"not a domain name: #{other.inspect}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Name</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@absolute</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">absolute?</span>
<span class="ruby-identifier">other_len</span> = <span class="ruby-identifier">other</span>.<span class="ruby-identifier">length</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@labels</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">other_len</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@labels</span>[<span class="ruby-operator">-</span><span class="ruby-identifier">other_len</span>, <span class="ruby-identifier">other_len</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_a</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns the domain name as a string.</p>
<p>The domain name doesn't have a trailing dot even if the name object is absolute.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"x.y.z."</span>).<span class="ruby-identifier">to_s</span> <span class="ruby-comment">#=> "x.y.z"</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">Resolv</span><span class="ruby-operator">::</span><span class="ruby-constant">DNS</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"x.y.z"</span>).<span class="ruby-identifier">to_s</span> <span class="ruby-comment">#=> "x.y.z"</span>
</pre>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/resolv.rb, line 1332</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@labels</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'.'</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>