core
API
Generated with
core/sttp.model/Uri

Uri

sttp.model.Uri$
See theUri companion class
object Uri extends UriInterpolator

For a general description of the behavior of apply, parse, safeApply and unsafeApply methods, see sttp.model.

The safeApply methods return a validation error if the scheme contains illegal characters or if the host is empty.

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Uri.type

Members list

Concise view

Type members

Classlikes

case class AbsolutePath(segments: Seq[Segment]) extends PathSegments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Authority(userInfo: Option[UserInfo], hostSegment: Segment, port: Option[Int])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Authority

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object EmptyPath extends PathSegments

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
object FragmentEncoding

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object FragmentSegment

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object HostEncoding

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object HostSegment

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object PathSegment

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object PathSegmentEncoding

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object PathSegments

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait PathSegments

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object EmptyPath.type
object QuerySegment

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait QuerySegment

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class KeyValue
class Plain
class Value
object QuerySegmentEncoding

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class RelativePath(segments: Seq[Segment]) extends PathSegments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Segment(v: String, encoding: Encoding)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class UserInfo(username: String, password: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Inherited classlikes

implicit class UriContext(val sc: StringContext)

Attributes

Inherited from:
UriInterpolator
Graph
Supertypes
class Object
trait Matchable
class Any

Types

type Encoding = String => String

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(host: String): Uri
def apply(host: String, port: Int): Uri
def apply(host: String, port: Int, path: Seq[String]): Uri
def apply(scheme: String, path: Seq[String]): Uri
def apply(scheme: String, host: String): Uri
def apply(scheme: String, host: String, port: Int): Uri
def apply(scheme: String, host: String, port: Int, path: Seq[String]): Uri
def apply(scheme: String, host: String, path: Seq[String]): Uri
def apply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Uri
def apply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri
def apply(scheme: String, authority: Option[Authority], path: Seq[Segment], querySegments: Seq[QuerySegment], fragment: Option[Segment]): Uri
def apply(javaUri: URI): Uri
def parse(uri: String): Either[String, Uri]
def pathRelative(path: Seq[String]): Uri

Create a relative URI with a relative path.

Create a relative URI with a relative path.

Attributes

def pathRelative(path: Seq[String], fragment: Option[String]): Uri

Create a relative URI with a relative path.

Create a relative URI with a relative path.

Attributes

def pathRelative(path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri

Create a relative URI with a relative path.

Create a relative URI with a relative path.

Attributes

def relative(path: Seq[String]): Uri

Create a relative URI with an absolute path.

Create a relative URI with an absolute path.

Attributes

def relative(path: Seq[String], fragment: Option[String]): Uri

Create a relative URI with an absolute path.

Create a relative URI with an absolute path.

Attributes

def relative(path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri

Create a relative URI with an absolute path.

Create a relative URI with an absolute path.

Attributes

def safeApply(host: String): Either[String, Uri]
def safeApply(host: String, port: Int): Either[String, Uri]
def safeApply(host: String, port: Int, path: Seq[String]): Either[String, Uri]
def safeApply(scheme: String, path: Seq[String]): Either[String, Uri]
def safeApply(scheme: String, host: String): Either[String, Uri]
def safeApply(scheme: String, host: String, port: Int): Either[String, Uri]
def safeApply(scheme: String, host: String, port: Int, path: Seq[String]): Either[String, Uri]
def safeApply(scheme: String, host: String, path: Seq[String]): Either[String, Uri]
def safeApply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Either[String, Uri]
def safeApply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Either[String, Uri]
def safeApply(scheme: String, authority: Option[Authority], pathSegments: Seq[Segment], querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment]): Either[String, Uri]
def unsafeApply(host: String): Uri
def unsafeApply(host: String, port: Int): Uri
def unsafeApply(host: String, port: Int, path: Seq[String]): Uri
def unsafeApply(scheme: String, path: Seq[String]): Uri
def unsafeApply(scheme: String, host: String): Uri
def unsafeApply(scheme: String, host: String, port: Int): Uri
def unsafeApply(scheme: String, host: String, port: Int, path: Seq[String]): Uri
def unsafeApply(scheme: String, host: String, path: Seq[String]): Uri
def unsafeApply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Uri
def unsafeApply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri
def unsafeApply(scheme: String, authority: Option[Authority], pathSegments: Seq[Segment], querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment]): Uri
def unsafeParse(uri: String): Uri

Implicits

Inherited implicits

final implicit def UriContext(sc: StringContext): UriContext

Attributes

Inherited from:
UriInterpolator
Generated with