ip4s-core
3.3.0
API
Generated with
ip4s-core/com.comcast.ip4s/IDN

IDN

com.comcast.ip4s.IDN
See theIDN companion object
final class IDN extends Host

Internationalized domain name, as specified by RFC3490 and RFC5891.

This type models internationalized hostnames. An IDN provides unicode labels, a unicode string form, and an ASCII hostname form.

A well formed IDN consists of one or more labels separated by dots. Each label may contain unicode characters as long as the converted ASCII form meets the requirements of RFC1123 (e.g., 63 or fewer characters and no leading or trailing dash). A dot is represented as an ASCII period or one of the unicode dots: full stop, ideographic full stop, fullwidth full stop, halfwidth ideographic full stop.

The toString method returns the IDN in the form in which it was constructed. Sometimes it is useful to normalize the IDN -- converting all dots to an ASCII period and converting all labels to lowercase.

Note: equality and comparison of IDNs is case-sensitive. Consider comparing normalized toString values for a more lenient notion of equality.

Attributes

Companion:
object
Source:
Host.scala
Graph
Supertypes
trait Host
trait Ordered[Host]
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source:
Host.scala
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
Source:
Host.scala
def normalized: IDN

Converts this IDN to lower case and replaces dots with ASCII periods.

Converts this IDN to lower case and replaces dots with ASCII periods.

Attributes

Source:
Host.scala

Inherited methods

def <(that: Host): Boolean

Attributes

Inherited from:
Ordered
def <=(that: Host): Boolean

Attributes

Inherited from:
Ordered
def >(that: Host): Boolean

Attributes

Inherited from:
Ordered
def >=(that: Host): Boolean

Attributes

Inherited from:
Ordered
def compare(that: Host): Int

Attributes

Inherited from:
Host
Source:
Host.scala
def compareTo(that: Host): Int

Attributes

Inherited from:
Ordered
def resolve[F[_] : Applicative]: F[IpAddress]

Resolves this host to an ip address using the platform DNS resolver.

Resolves this host to an ip address using the platform DNS resolver.

If the host cannot be resolved, the effect fails with a com.comcast.ip4s.UnknownHostException.

Attributes

Inherited from:
Host
Source:
Host.scala
def resolveAll[F[_] : Applicative]: F[List[IpAddress]]

Resolves this host to all ip addresses known to the platform DNS resolver.

Resolves this host to all ip addresses known to the platform DNS resolver.

If the host cannot be resolved, an empty list is returned.

Attributes

Inherited from:
Host
Source:
Host.scala
def resolveOption[F[_] : ApplicativeThrow]: F[Option[IpAddress]]

Resolves this host to an ip address using the platform DNS resolver.

Resolves this host to an ip address using the platform DNS resolver.

If the host cannot be resolved, a None is returned.

Attributes

Inherited from:
Host
Source:
Host.scala

Concrete fields

val hostname: Hostname

Attributes

Source:
Host.scala
val labels: List[Label]

Attributes

Source:
Host.scala
override val toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Source:
Host.scala
Generated with