sttp

Type Members

sealed trait BasicRequestBody extends RequestBody[Nothing]
sealed trait BasicResponseAs[T, +S] extends ResponseAs[T, S]

Response handling specification which isn't derived from another response handling method, but needs to be handled directly by the backend.
type BodySerializer[B] = (B) ⇒ BasicRequestBody

Provide an implicit value of this type to serialize arbitrary classes into a request body.
Provide an implicit value of this type to serialize arbitrary classes into a request body. Backends might also provide special logic for serializer instances which they define (e.g. to handle streaming).
case class ByteArrayBody(b: Array[Byte], defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable
case class ByteBufferBody(b: ByteBuffer, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable
case class Cookie(name: String, value: String, expires: Option[ZonedDateTime] = None, maxAge: Option[Long] = None, domain: Option[String] = None, path: Option[String] = None, secure: Boolean = false, httpOnly: Boolean = false) extends Product with Serializable
type Empty[X] = None.type
class FollowRedirectsBackend[R[_], S] extends SttpBackend[R, S]
class FutureMonad extends MonadAsyncError[Future]
class HttpURLConnectionBackend extends SttpBackend[Id, Nothing]
type Id[X] = X
case class InputStreamBody(b: InputStream, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable
case class MappedResponseAs[T, T2, S](raw: BasicResponseAs[T, S], g: (T) ⇒ T2) extends ResponseAs[T2, S] with Product with Serializable
final case class Method(m: String) extends AnyVal with Product with Serializable
trait MonadAsyncError[R[_]] extends MonadError[R]
trait MonadError[R[_]] extends AnyRef
case class Multipart(name: String, body: BasicRequestBody, fileName: Option[String] = None, contentType: Option[String] = None, additionalHeaders: Map[String, String] = Map()) extends Product with Serializable

Use the factory methods multipart to conveniently create instances of this class.
Use the factory methods multipart to conveniently create instances of this class. A part can be then further customised using fileName, contentType and header methods.
case class MultipartBody(parts: Seq[Multipart]) extends RequestBody[Nothing] with Product with Serializable
type PartialRequest[T, +S] = RequestT[Empty, T, S]
case class PathBody(f: Path, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable
type Request[T, +S] = RequestT[Id, T, S]
sealed trait RequestBody[+S] extends AnyRef
case class RequestOptions(followRedirects: Boolean, readTimeout: Duration) extends Product with Serializable
case class RequestT[U[_], T, +S](method: U[Method], uri: U[Uri], body: RequestBody[S], headers: Seq[(String, String)], response: ResponseAs[T, S], options: RequestOptions, tags: Map[String, Any]) extends Product with Serializable

U
Specifies if the method & uri are specified. By default can be either: * Empty, which is a type constructor which always resolves to None. This type of request is aliased to PartialRequest: there's no method and uri specified, and the request cannot be sent. * Id, which is an identity type constructor. This type of request is aliased to Request: the method and uri are specified, and the request can be sent.
response
What's the target type to which the response body should be read. Needs to be specified upfront so that the response is always consumed and hence there are no requirements on client code to consume it. An exception to this are streaming responses, which need to fully consumed by the client if such a response type is requested.
tags
Request-specific tags which can be used by backends for logging, metrics, etc. Not used by default.
case class Response[T](body: Either[String, T], code: Int, statusText: String, headers: Seq[(String, String)], history: List[Response[Unit]]) extends Product with Serializable

body
Right(T), if the request was successful (status code 2xx). The body is then handled as specified in the request. Left(String), if the request wasn't successful (status code 3xx, 4xx or 5xx). In this case, the response body is read into a String.
history
If redirects are followed, and there were redirects, contains responses for the intermediate requests. The first response (oldest) comes first.
sealed trait ResponseAs[T, +S] extends AnyRef

T
Target type as which the response will be read.
S
If T is a stream, the type of the stream. Otherwise, Nothing.
case class ResponseAsFile(output: File, overwrite: Boolean) extends BasicResponseAs[File, Nothing] with Product with Serializable
case class ResponseAsStream[T, S]()(implicit responseIsStream: =:=[S, T]) extends BasicResponseAs[T, S] with Product with Serializable
case class ResponseAsString(encoding: String) extends BasicResponseAs[String, Nothing] with Product with Serializable
class SpecifyAuthScheme[U[_], T, +S] extends AnyRef
case class StreamBody[S](s: S) extends RequestBody[S] with Product with Serializable
case class StringBody(s: String, encoding: String, defaultContentType: Option[String] = Some(TextPlainContentType)) extends BasicRequestBody with Product with Serializable
trait SttpBackend[R[_], -S] extends AnyRef

R
The type constructor in which responses are wrapped. E.g. Id for synchronous backends, Future for asynchronous backends.
S
The type of streams that are supported by the backend. Nothing, if streaming requests/responses is not supported by this backend.
case class SttpBackendOptions(connectionTimeout: FiniteDuration, proxy: Option[Proxy]) extends Product with Serializable
class TryBackend[-S] extends SttpBackend[Try, S]

A Backend that safely wraps SttpBackend exceptions in Try's
A Backend that safely wraps SttpBackend exceptions in Try's
S
The type of streams that are supported by the backend. Nothing, if streaming requests/responses is not supported by this backend.
case class Uri(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], queryFragments: Seq[QueryFragment], fragment: Option[String]) extends Product with Serializable

A URI.
A URI. All components (scheme, host, query, ...) are stored unencoded, and become encoded upon serialization (using toString).
queryFragments
Either key-value pairs, single values, or plain query fragments. Key value pairs will be serialized as k=v, and blocks of key-value pairs/single values will be combined using &. Note that no & or other separators are added around plain query fragments - if required, they need to be added manually as part of the plain query fragment.
implicit final class UriContext extends AnyVal

Value Members

object Cookie extends Serializable
val DefaultReadTimeout: Duration
object FollowRedirectsBackend
object HttpURLConnectionBackend
object IdMonad extends MonadError[Id]
object IgnoreResponse extends BasicResponseAs[Unit, Nothing] with Product with Serializable
object Method extends Serializable
object NoBody extends RequestBody[Nothing] with Product with Serializable
object RequestBody
object ResponseAs
object ResponseAsByteArray extends BasicResponseAs[Array[Byte], Nothing] with Product with Serializable
object SttpBackendOptions extends Serializable
object TryHttpURLConnectionBackend
object TryMonad extends MonadError[Try]
object Uri extends Serializable
object UriInterpolator
def asByteArray: ResponseAs[Array[Byte], Nothing]
def asFile(file: File, overwrite: Boolean = false): ResponseAs[File, Nothing]
def asParams(encoding: String): ResponseAs[Seq[(String, String)], Nothing]

Use the given encoding by default, unless specified otherwise in the response headers.
def asParams: ResponseAs[Seq[(String, String)], Nothing]

Use the utf-8 encoding by default, unless specified otherwise in the response headers.
def asPath(path: Path, overwrite: Boolean = false): ResponseAs[Path, Nothing]
def asStream[S]: ResponseAs[S, S]
def asString(encoding: String): ResponseAs[String, Nothing]

Use the given encoding by default, unless specified otherwise in the response headers.
def asString: ResponseAs[String, Nothing]

Use the utf-8 encoding by default, unless specified otherwise in the response headers.
val emptyRequest: RequestT[Empty, String, Nothing]

An empty request with no headers.
def ignore: ResponseAs[Unit, Nothing]
def multipart[B](name: String, b: B)(implicit arg0: BodySerializer[B]): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
def multipart(name: String, fs: Seq[(String, String)], encoding: String): Multipart

Encodes the given parameters as form data.
Encodes the given parameters as form data.
Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.
def multipart(name: String, fs: Seq[(String, String)]): Multipart

Encodes the given parameters as form data using utf-8.
Encodes the given parameters as form data using utf-8.
Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.
def multipart(name: String, fs: Map[String, String], encoding: String): Multipart

Encodes the given parameters as form data.
Encodes the given parameters as form data.
Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.
def multipart(name: String, fs: Map[String, String]): Multipart

Encodes the given parameters as form data using utf-8.
Encodes the given parameters as form data using utf-8.
Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.
def multipart(name: String, data: Path): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
Content type will be set to application/octet-stream, can be overridden later using the contentType method.
File name will be set to the name of the file.
def multipart(name: String, data: File): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
Content type will be set to application/octet-stream, can be overridden later using the contentType method.
File name will be set to the name of the file.
def multipart(name: String, data: InputStream): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
def multipart(name: String, data: ByteBuffer): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
def multipart(name: String, data: Array[Byte]): Multipart

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
def multipart(name: String, data: String, encoding: String): Multipart

Content type will be set to text/plain with utf-8 encoding, can be overridden later using the contentType method.
def multipart(name: String, data: String): Multipart

Content type will be set to text/plain with utf-8 encoding, can be overridden later using the contentType method.
val sttp: RequestT[Empty, String, Nothing]

A starting request, with the following modifications comparing to emptyRequest:
A starting request, with the following modifications comparing to emptyRequest:
- Accept-Encoding set to gzip, deflate (handled automatically by the library)
package testing

package sttp

Type Members

sealed trait BasicRequestBody extends RequestBody[Nothing]

sealed trait BasicResponseAs[T, +S] extends ResponseAs[T, S]

type BodySerializer[B] = (B) ⇒ BasicRequestBody

case class ByteArrayBody(b: Array[Byte], defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable

case class ByteBufferBody(b: ByteBuffer, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable

case class Cookie(name: String, value: String, expires: Option[ZonedDateTime] = None, maxAge: Option[Long] = None, domain: Option[String] = None, path: Option[String] = None, secure: Boolean = false, httpOnly: Boolean = false) extends Product with Serializable

type Empty[X] = None.type

class FollowRedirectsBackend[R[_], S] extends SttpBackend[R, S]

class FutureMonad extends MonadAsyncError[Future]

class HttpURLConnectionBackend extends SttpBackend[Id, Nothing]

type Id[X] = X

case class InputStreamBody(b: InputStream, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable

case class MappedResponseAs[T, T2, S](raw: BasicResponseAs[T, S], g: (T) ⇒ T2) extends ResponseAs[T2, S] with Product with Serializable

final case class Method(m: String) extends AnyVal with Product with Serializable

trait MonadAsyncError[R[_]] extends MonadError[R]

trait MonadError[R[_]] extends AnyRef

case class Multipart(name: String, body: BasicRequestBody, fileName: Option[String] = None, contentType: Option[String] = None, additionalHeaders: Map[String, String] = Map()) extends Product with Serializable

case class MultipartBody(parts: Seq[Multipart]) extends RequestBody[Nothing] with Product with Serializable

type PartialRequest[T, +S] = RequestT[Empty, T, S]

case class PathBody(f: Path, defaultContentType: Option[String] = ...) extends BasicRequestBody with Product with Serializable

type Request[T, +S] = RequestT[Id, T, S]

sealed trait RequestBody[+S] extends AnyRef

case class RequestOptions(followRedirects: Boolean, readTimeout: Duration) extends Product with Serializable

case class RequestT[U[_], T, +S](method: U[Method], uri: U[Uri], body: RequestBody[S], headers: Seq[(String, String)], response: ResponseAs[T, S], options: RequestOptions, tags: Map[String, Any]) extends Product with Serializable

case class Response[T](body: Either[String, T], code: Int, statusText: String, headers: Seq[(String, String)], history: List[Response[Unit]]) extends Product with Serializable

sealed trait ResponseAs[T, +S] extends AnyRef

case class ResponseAsFile(output: File, overwrite: Boolean) extends BasicResponseAs[File, Nothing] with Product with Serializable

case class ResponseAsStream[T, S]()(implicit responseIsStream: =:=[S, T]) extends BasicResponseAs[T, S] with Product with Serializable

case class ResponseAsString(encoding: String) extends BasicResponseAs[String, Nothing] with Product with Serializable

class SpecifyAuthScheme[U[_], T, +S] extends AnyRef

case class StreamBody[S](s: S) extends RequestBody[S] with Product with Serializable

case class StringBody(s: String, encoding: String, defaultContentType: Option[String] = Some(TextPlainContentType)) extends BasicRequestBody with Product with Serializable

trait SttpBackend[R[_], -S] extends AnyRef

case class SttpBackendOptions(connectionTimeout: FiniteDuration, proxy: Option[Proxy]) extends Product with Serializable

class TryBackend[-S] extends SttpBackend[Try, S]

case class Uri(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], queryFragments: Seq[QueryFragment], fragment: Option[String]) extends Product with Serializable

implicit final class UriContext extends AnyVal

Value Members

object Cookie extends Serializable

val DefaultReadTimeout: Duration

object FollowRedirectsBackend

object HttpURLConnectionBackend

object IdMonad extends MonadError[Id]

object IgnoreResponse extends BasicResponseAs[Unit, Nothing] with Product with Serializable

object Method extends Serializable

object NoBody extends RequestBody[Nothing] with Product with Serializable

object RequestBody

object ResponseAs

object ResponseAsByteArray extends BasicResponseAs[Array[Byte], Nothing] with Product with Serializable

object SttpBackendOptions extends Serializable

object TryHttpURLConnectionBackend

object TryMonad extends MonadError[Try]

object Uri extends Serializable

object UriInterpolator

def asByteArray: ResponseAs[Array[Byte], Nothing]

def asFile(file: File, overwrite: Boolean = false): ResponseAs[File, Nothing]

def asParams(encoding: String): ResponseAs[Seq[(String, String)], Nothing]

def asParams: ResponseAs[Seq[(String, String)], Nothing]

def asPath(path: Path, overwrite: Boolean = false): ResponseAs[Path, Nothing]

def asStream[S]: ResponseAs[S, S]

def asString(encoding: String): ResponseAs[String, Nothing]

def asString: ResponseAs[String, Nothing]

val emptyRequest: RequestT[Empty, String, Nothing]

def ignore: ResponseAs[Unit, Nothing]

def multipart[B](name: String, b: B)(implicit arg0: BodySerializer[B]): Multipart

def multipart(name: String, fs: Seq[(String, String)], encoding: String): Multipart

def multipart(name: String, fs: Seq[(String, String)]): Multipart

def multipart(name: String, fs: Map[String, String], encoding: String): Multipart

def multipart(name: String, fs: Map[String, String]): Multipart

def multipart(name: String, data: Path): Multipart

def multipart(name: String, data: File): Multipart

def multipart(name: String, data: InputStream): Multipart

def multipart(name: String, data: ByteBuffer): Multipart

def multipart(name: String, data: Array[Byte]): Multipart

def multipart(name: String, data: String, encoding: String): Multipart

def multipart(name: String, data: String): Multipart

val sttp: RequestT[Empty, String, Nothing]