Uri

Type Members

final case class Authority(userInfo: Option[UserInfo] = None, host: Host = RegName("localhost"), port: Option[Int] = None) extends Renderable with Product with Serializable
type Fragment = String
sealed trait Host extends Renderable
final case class IPv4(address: CaseInsensitiveString) extends Host with Product with Serializable
final case class IPv6(address: CaseInsensitiveString) extends Host with Product with Serializable
class Macros extends AnyRef
type Path = String
final case class RegName(host: CaseInsensitiveString) extends Host with Product with Serializable
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
https://www.ietf.org/rfc/rfc3986.txt, Section 3.1
type UserInfo = String

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object IPv4 extends Serializable
object IPv6 extends Serializable
object RegName extends Serializable
object Scheme
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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.
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.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fromString(s: String): ParseResult[Uri]

Decodes the String to a Uri using the RFC 3986 uri decoding specification
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit val http4sUriEq: Eq[Uri]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pathEncode(s: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8): String
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
def requestTarget(s: String): ParseResult[Uri]

Decodes the String to a Uri using the RFC 7230 section 5.3 uri decoding specification
def resolve(base: Uri, reference: Uri): Uri

Resolve a relative Uri reference, per RFC 3986 sec 5.2
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

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

Related Docs: class Uri | package http4s

object Uri extends Serializable

Type Members

final case class Authority(userInfo: Option[UserInfo] = None, host: Host = RegName("localhost"), port: Option[Int] = None) extends Renderable with Product with Serializable

type Fragment = String

sealed trait Host extends Renderable

final case class IPv4(address: CaseInsensitiveString) extends Host with Product with Serializable

final case class IPv6(address: CaseInsensitiveString) extends Host with Product with Serializable

class Macros extends AnyRef

type Path = String

final case class RegName(host: CaseInsensitiveString) extends Host with Product with Serializable

final class Scheme extends Ordered[Scheme]

type UserInfo = String

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object IPv4 extends Serializable

object IPv6 extends Serializable

object RegName extends Serializable

object Scheme

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def decode(toDecode: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8, plusIsSpace: Boolean = false, toSkip: (Char) ⇒ Boolean = Function.const(false)): String

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromString(s: String): ParseResult[Uri]

final def getClass(): Class[_]

def hashCode(): Int

implicit val http4sUriEq: Eq[Uri]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pathEncode(s: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8): String

def removeDotSegments(path: String): String

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

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

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unsafeFromString(s: String): Uri

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

macro def uri(s: String): Uri

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped