sttp

Type Members

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. Handlers might also provide special logic for serializer instances which they define (e.g. to handle streaming).
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 FutureMonad extends MonadAsyncError[Future]
type Id[X] = X
trait MonadAsyncError[R[_]] extends MonadError[R]
trait MonadError[R[_]] extends AnyRef
case class MultiPart(name: String, data: 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.
type PartialRequest[T, +S] = RequestT[Empty, T, S]
type Request[T, +S] = RequestT[Id, T, S]
case class RequestT[U[_], T, +S](method: U[Method], uri: U[Uri], body: RequestBody[S], headers: Seq[(String, String)], responseAs: ResponseAs[T, S]) 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.
case class Response[T](body: T, code: Int, headers: Seq[(String, String)]) extends Product with Serializable
class SpecifyAuthScheme[U[_], T, +S] extends AnyRef
trait SttpHandler[R[_], -S] extends AnyRef

R
The type constructor in which responses are wrapped. E.g. Id for synchronous handlers, Future for asynchronous handlers.
S
The type of streams that are supported by the handler. Nothing, if streaming requests/responses is not supported by this handler.
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
object HttpURLConnectionSttpHandler extends SttpHandler[Id, Nothing]
object IdMonad extends MonadError[Id]
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]

Uses utf-8 encoding.
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]

Uses utf-8 encoding.
val emptyRequest: RequestT[Empty, String, Nothing]

An empty request with no headers.
def ignore: ResponseAs[Unit, Nothing]
package model
def multiPart(name: String, data: Path): MultiPart

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

Content type will be set to application/octet-stream, can be overridden later using the contentType method.
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 sttp

Type Members

type BodySerializer[B] = (B) ⇒ BasicRequestBody

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 FutureMonad extends MonadAsyncError[Future]

type Id[X] = X

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

trait MonadError[R[_]] extends AnyRef

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

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

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

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

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

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

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

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

object HttpURLConnectionSttpHandler extends SttpHandler[Id, Nothing]

object IdMonad extends MonadError[Id]

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]

package model

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]

Inherited from AnyRef

Inherited from Any

Ungrouped