123456789_123456789_123456789_123456789_123456789_

Class: Resolv::DNS::Name

Relationships & Source Files
Inherits: Object
Defined in: lib/resolv.rb

Overview

A representation of a ::Resolv::DNS name.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(labels, absolute = true) ⇒ Name

This method is for internal use only.
[ GitHub ] 

  


# File 'lib/resolv.rb', line 1259



def initialize(labels, absolute=true) # :nodoc:
  labels = labels.map {|label|
    case label
    when String then Label::Str.new(label)
    when Label::Str then label
    else
      raise ArgumentError, "unexpected label: #{label.inspect}"
    end
  }
  @labels = labels
  @absolute = absolute
end


  







Class Method Details



  

    .create(arg)  
  



  

    

Creates a new ::Resolv::DNS name from arg.  arg can be:


Name



returns arg.


String



Creates a new Name.




  



  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1248



def self.create(arg)
  case arg
  when Name
    return arg
  when String
    return Name.new(Label.split(arg), /\.\z/ =~ arg ? true : false)
  else
    raise ArgumentError.new("cannot interpret as DNS name: #{arg.inspect}")
  end
end


  







Instance Attribute Details



  

    #absolute?  ⇒ Boolean  (readonly)
  



  

    

True if this name is absolute.


  





  


  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1279



def absolute?
  return @absolute
end


  







Instance Method Details



  

    #==(other)  
    Also known as: #eql?
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1283



def ==(other) # :nodoc:
  return false unless Name === other
  return false unless @absolute == other.absolute?
  return @labels == other.to_a
end


  








  

    #[](i)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1325



def [](i) # :nodoc:
  return @labels[i]
end


  








  

    #eql?(other)  
  

  

    This method is for internal use only.
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1289



alias eql? == # :nodoc:


  








  

    #hash  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1313



def hash # :nodoc:
  return @labels.hash ^ @absolute.hash
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1272



def inspect # :nodoc:
  "#<#{self.class}: #{self}#{@absolute ? '.' : ''}>"
end


  








  

    #length  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1321



def length # :nodoc:
  return @labels.length
end


  








  

    #subdomain_of?(other)  ⇒ Boolean 
  



  

    

Returns true if other is a subdomain.



Example:



domain = Resolv::DNS::Name.create("y.z")
p Resolv::DNS::Name.create("w.x.y.z").subdomain_of?(domain) #=> true
p Resolv::DNS::Name.create("x.y.z").subdomain_of?(domain) #=> true
p Resolv::DNS::Name.create("y.z").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("z").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("x.y.z.").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("w.z").subdomain_of?(domain) #=> false


  





  
Raises:


    
  
  • 
    (ArgumentError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1305



def subdomain_of?(other)
  raise ArgumentError, "not a domain name: #{other.inspect}" unless Name === other
  return false if @absolute != other.absolute?
  other_len = other.length
  return false if @labels.length <= other_len
  return @labels[-other_len, other_len] == other.to_a
end


  








  

    #to_a  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1317



def to_a # :nodoc:
  return @labels
end


  








  

    #to_s  
  



  

    

returns the domain name as a string.



The domain name doesn't have a trailing dot even if the name object is absolute.



Example:



p Resolv::DNS::Name.create("x.y.z.").to_s #=> "x.y.z"
p Resolv::DNS::Name.create("x.y.z").to_s #=> "x.y.z"


  



  [ GitHub ]


  

  


# File 'lib/resolv.rb', line 1340



def to_s
  return @labels.join('.')
end