Packages

object Uri extends Serializable

Source
Uri.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Authority(userInfo: Option[UserInfo] = None, host: Host = RegName("localhost"), port: Option[Int] = None) extends Renderable with Product with Serializable
  2. type Fragment = String
  3. sealed trait Host extends Renderable
  4. final case class Ipv4Address(a: Byte, b: Byte, c: Byte, d: Byte) extends Host with Ordered[Ipv4Address] with Serializable with Product
  5. final case class Ipv6Address(a: Short, b: Short, c: Short, d: Short, e: Short, f: Short, g: Short, h: Short) extends Host with Ordered[Ipv6Address] with Serializable with Product
  6. type Path = String
  7. final case class RegName(host: CaseInsensitiveString) extends Host with Product with Serializable
  8. final class Scheme extends Ordered[Scheme]

    A org.http4s.Uri may begin with a scheme name that refers to a specification for assigning identifiers within that scheme.

    A org.http4s.Uri may begin with a scheme name that refers to a specification for assigning identifiers within that scheme.

    If the scheme is defined, the URI is absolute. If the scheme is not defined, the URI is a relative reference.

    See also

    RFC 3986, Section 3.1, Scheme

  9. final case class UserInfo extends Ordered[UserInfo] with Product with Serializable

    The userinfo subcomponent may consist of a user name and, optionally, scheme-specific information about how to gain authorization to access the resource.

    The userinfo subcomponent may consist of a user name and, optionally, scheme-specific information about how to gain authorization to access the resource. The user information, if present, is followed by a commercial at-sign ("@") that delimits it from the host.

    See also

    RFC 3986, Section 3.2.1, User Information

  10. type IPv4 = Ipv4Address
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-M2) Renamed to Ipv4Address, modeled as case class of bytes

  11. type IPv6 = Ipv6Address
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-M2) Renamed to Ipv6Address, modeled as case class of bytes

  12. class Macros extends AnyRef
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.16) This location of the implementation complicates Dotty support

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. implicit val catsInstancesForHttp4sUri: Hash[Uri] with Order[Uri] with Show[Uri]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def decode(toDecode: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8, plusIsSpace: Boolean = false, toSkip: (Char) ⇒ Boolean = Function.const(false)): String

    Percent-decodes a string.

    Percent-decodes a string.

    toDecode

    the string to decode

    charset

    the charset of percent-encoded characters

    plusIsSpace

    true if '+' is to be interpreted as a ' '

    toSkip

    a predicate of characters whose percent-encoded form is left percent-encoded. Almost certainly should be left empty.

  8. def encode(toEncode: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8, spaceIsPlus: Boolean = false, toSkip: (Char) ⇒ Boolean = toSkip): String

    Percent-encodes a string.

    Percent-encodes a string. Depending on the parameters, this method is appropriate for URI or URL form encoding. Any resulting percent-encodings are normalized to uppercase.

    toEncode

    the string to encode

    charset

    the charset to use for characters that are percent encoded

    spaceIsPlus

    if space is not skipped, determines whether it will be rendreed as a "+" or a percent-encoding according to charset.

    toSkip

    a predicate of characters exempt from encoding. In typical use, this is composed of all Unreserved URI characters and sometimes a subset of Reserved URI characters.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def fromString(s: String): ParseResult[Uri]

    Decodes the String to a Uri using the RFC 3986 uri decoding specification

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def pathEncode(s: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8): String
  20. def removeDotSegments(path: String): String

    Remove dot sequences from a Path, per RFC 3986 Sec 5.2.4 Adapted from" https://github.com/Norconex/commons-lang/blob/c83fdeac7a60ac99c8602e0b47056ad77b08f570/norconex-commons-lang/src/main/java/com/norconex/commons/lang/url/URLNormalizer.java#L429

  21. def requestTarget(s: String): ParseResult[Uri]

    Decodes the String to a Uri using the RFC 7230 section 5.3 uri decoding specification

  22. def resolve(base: Uri, reference: Uri): Uri

    Resolve a relative Uri reference, per RFC 3986 sec 5.2

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def unsafeFromString(s: String): Uri

    Parses a String to a Uri according to RFC 3986.

    Parses a String to a Uri according to RFC 3986. If decoding fails, throws a ParseFailure.

    For totality, call #fromString. For compile-time verification of literals, call #uri.

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. object Authority extends AbstractFunction3[Option[UserInfo], Host, Option[Int], Authority] with Serializable
  30. object Host
  31. object Ipv4Address extends Serializable
  32. object Ipv6Address extends Serializable
  33. object RegName extends Serializable
  34. object Scheme
  35. object UserInfo extends Serializable

Deprecated Value Members

  1. def http4sUriEq: Eq[Uri]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.14) Please use catsInstancesForHttp4sUri. Kept for binary compatibility

  2. macro def uri(s: String): Uri

    Literal syntax for URIs.

    Literal syntax for URIs. Invalid or non-literal arguments are rejected at compile time.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.20) use uri"" string interpolation instead

  3. object IPv4
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-M2) Renamed to Ipv4Address, modeled as case class of bytes

  4. object IPv6
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-M2) Renamed to Ipv6Address, modeled as case class of bytes

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped