Type Members

1.  sealed trait AbsoluteOrEmptyPath extends UrlPath

   This trait has two subclasses; AbsolutePath and EmptyPath.

   This trait has two subclasses; AbsolutePath and EmptyPath. This encompasses the paths allowed to be used in URLs that have an Authority. As per RFC 3986:

   When authority is present, the path must either be empty or begin with a slash ("/") character.

2.  final case class AbsolutePath(parts: Vector[String])(implicit config: UriConfig = UriConfig.default) extends AbsoluteOrEmptyPath with Product with Serializable

   An AbsolutePath is a path that starts with a slash

3.  final case class AbsoluteUrl(scheme: String, authority: Authority, path: AbsoluteOrEmptyPath, query: QueryString, fragment: Option[String])(implicit config: UriConfig = UriConfig.default) extends UrlWithAuthority with Product with Serializable

   Represents absolute URLs, for example: http://example.com

4.  case class Authority(userInfo: UserInfo, host: Host, port: Option[Int])(implicit config: UriConfig) extends Product with Serializable
5.  final case class DomainName(value: String) extends Host with PublicSuffixSupportImpl with PunycodeSupport with Product with Serializable
6.  sealed trait Host extends PublicSuffixSupport
7.  final case class IpV4(octet1: Byte, octet2: Byte, octet3: Byte, octet4: Byte) extends Host with Product with Serializable
8.  final case class IpV6(piece1: Char, piece2: Char, piece3: Char, piece4: Char, piece5: Char, piece6: Char, piece7: Char, piece8: Char) extends Host with Product with Serializable
9.  sealed trait Path extends Product with Serializable
10.  final case class ProtocolRelativeUrl(authority: Authority, path: AbsoluteOrEmptyPath, query: QueryString, fragment: Option[String])(implicit config: UriConfig = UriConfig.default) extends UrlWithAuthority with Product with Serializable

    Represents absolute URLs, for example: //example.com

11.  case class QueryString(params: Vector[(String, Option[String])])(implicit config: UriConfig = UriConfig.default) extends Product with Serializable
12.  final case class RelativeUrl(path: UrlPath, query: QueryString, fragment: Option[String])(implicit config: UriConfig = UriConfig.default) extends Url with Product with Serializable

    Represents Relative URLs which do not contain an authority.

    Represents Relative URLs which do not contain an authority. Examples include:

    • Root Relative: /index.html?a=b
    • Rootless Relative: index.html?a=b
    • Rootless Relative (with dot segment): ../index.html?a=b
13.  final case class RootlessPath(parts: Vector[String])(implicit config: UriConfig = UriConfig.default) extends UrlPath with Product with Serializable
14.  sealed trait Uri extends Product with Serializable

    Represents a URI.

    Represents a URI. See RFC 3986

    Can either be a URL or a URN

    URLs will be one of these forms:

    • Absolute: http://example.com
    • Protocol Relative: //example.com
    • Without Authority: mailto:[email protected]
    • Root Relative: /index.html?a=b
    • Rootless Relative: index.html?a=b
    • Rootless Relative (with doc segment): ../index.html?a=b

    URNs will be in the form urn:example:example2

15.  class UriConversionException extends UriException
16.  class UriException extends Exception
17.  sealed trait Url extends Uri

    Represents a URL, which will be one of these forms:

    Represents a URL, which will be one of these forms:

    • Absolute: http://example.com
    • Protocol Relative: //example.com
    • Without Authority: mailto:[email protected]
    • Root Relative: /index.html?a=b
    • Rootless Relative: index.html?a=b
    • Rootless Relative (with doc segment): ../index.html?a=b
18.  sealed trait UrlPath extends Path
19.  sealed trait UrlWithAuthority extends Url

    Represents absolute URLs with an authority (i.e.

    Represents absolute URLs with an authority (i.e. URLs with a host), examples include:

    • Absolute URL: http://example.com
    • Protocol Relative URL: //example.com
20.  final case class UrlWithoutAuthority(scheme: String, path: UrlPath, query: QueryString, fragment: Option[String])(implicit config: UriConfig = UriConfig.default) extends Url with Product with Serializable

    Represents URLs that do not have an authority, for example: mailto:[email protected]

21.  final case class Urn(path: UrnPath)(implicit config: UriConfig = UriConfig.default) extends Uri with Product with Serializable

    Represents a URN.

    Represents a URN. See RFC 2141 and RFC 8141

    URNs will be in the form urn:nid:nss

22.  final case class UrnPath(nid: String, nss: String)(implicit config: UriConfig = UriConfig.default) extends Path with Product with Serializable
23.  case class UserInfo(user: Option[String], password: Option[String]) extends Product with Serializable