unidocs
1.0.0-M41
API
Generated with
unidocs/org.http4s/Uri

Uri

org.http4s.Uri
See theUri companion class
object Uri extends UriPlatform

Attributes

Companion
class
Source
Uri.scala
Graph
Supertypes
trait Product
trait Mirror
trait UriPlatform
class Object
trait Matchable
class Any
Show all
Self type
Uri.type

Members list

Type members

Classlikes

final case class Authority(userInfo: Option[UserInfo], host: Host, port: Option[Int]) extends Renderable

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object Authority

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Authority.type
object Host

Attributes

Companion
trait
Source
Uri.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Host.type
sealed trait Host extends Renderable

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
Known subtypes
class Ipv4Address
class Ipv6Address
class RegName
final case class Ipv4Address(address: Ipv4Address) extends Host, Ordered[Ipv4Address], Serializable

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Product
trait Equals
trait Serializable
trait Host
trait Renderable
class Object
trait Matchable
class Any
Show all
object Ipv4Address

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Ipv6Address(address: Ipv6Address) extends Host, Ordered[Ipv6Address], Serializable

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Product
trait Equals
trait Serializable
trait Host
trait Renderable
class Object
trait Matchable
class Any
Show all
object Ipv6Address

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final class Path extends Renderable

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
object Path

Attributes

Companion
class
Source
Uri.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Path.type
final case class RegName(host: CIString) extends Host

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Host
trait Renderable
class Object
trait Matchable
class Any
Show all
object RegName

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RegName.type
final case 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.

Attributes

See also
Companion
object
Source
Uri.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Ordered[Scheme]
class Object
trait Matchable
class Any
Show all
object Scheme

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Scheme.type
final case class UserInfo extends Ordered[UserInfo]

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.

Value parameters

password

The password, decoded. Passing a password in clear text in a URI is a security risk and deprecated by RFC 3986, but preserved in this model for losslessness.

username

The username component, decoded.

Attributes

See also
Companion
object
Source
Uri.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Ordered[UserInfo]
class Object
trait Matchable
class Any
Show all
object UserInfo

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
UserInfo.type

Types

type Fragment = String

Attributes

Source
Uri.scala

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def decode(toDecode: String, charset: Charset, plusIsSpace: Boolean, toSkip: Char => Boolean): String

Percent-decodes a string.

Percent-decodes a string.

Value parameters

charset

the charset of percent-encoded characters

plusIsSpace

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

toDecode

the string to decode

toSkip

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

Attributes

Source
Uri.scala
def encode(toEncode: String, charset: Charset, spaceIsPlus: Boolean, toSkip: Char => Boolean): 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.

Value parameters

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.

toEncode

the string to encode

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.

Attributes

Source
Uri.scala
def fromString(s: String): ParseResult[Uri]

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

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

Attributes

Source
Uri.scala
def pathEncode(s: String, charset: Charset): String

Attributes

Source
Uri.scala
def removeDotSegments(path: Path): Path

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

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

Attributes

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

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

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

Attributes

Source
Uri.scala
def resolve(base: Uri, reference: Uri): Uri

Resolve a relative Uri reference, per RFC 3986 sec 5.2

Resolve a relative Uri reference, per RFC 3986 sec 5.2

Attributes

Source
Uri.scala
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.

Attributes

Source
Uri.scala

Implicits

Implicits

implicit val catsInstancesForHttp4sUri: Hash[Uri] & Order[Uri] & Show[Uri]

Attributes

Source
Uri.scala
Generated with