core
API
Generated with
core/sttp.client3/HttpClientAsyncBackend

HttpClientAsyncBackend

sttp.client3.HttpClientAsyncBackend
abstract class HttpClientAsyncBackend[F[_], S, P, BH, B](client: HttpClient, monad: MonadAsyncError[F], closeClient: Boolean, customizeRequest: HttpRequest => HttpRequest, customEncodingHandler: EncodingHandler[B]) extends HttpClientBackend[F, S, P, B]

Type parameters

B

The higher-level body to which BH is transformed (e.g. a backend-native stream representation), which then is used to read the body as described by responseAs.

BH

The low-level type of the body, read using a HttpResponse.BodyHandler read by HttpClient.

F

The effect type

P

Capabilities supported by the backend. See SttpBackend.

S

Type of supported byte streams, Nothing if none

Attributes

Graph
Supertypes
class HttpClientBackend[F, S, P, B]
trait SttpBackend[F, P]
class Object
trait Matchable
class Any
Known subtypes

Members list

Type members

Inherited types

type PE = P & Effect[F]

Attributes

Inherited from:
HttpClientBackend

Value members

Abstract methods

protected def bodyHandlerBodyToBody(p: BH): B
protected def createBodyHandler: BodyHandler[BH]
protected def createSequencer: F[Sequencer[F]]
protected def createSimpleQueue[T]: F[SimpleQueue[F, T]]
protected def emptyBody(): B

Concrete methods

override def responseMonad: MonadError[F]

A monad instance for the effect type used when returning responses. Allows writing wrapper backends, which map/flatMap over the return value of send.

A monad instance for the effect type used when returning responses. Allows writing wrapper backends, which map/flatMap over the return value of send.

Attributes

Definition Classes
override def send[T, R >: PE](request: Request[T, R]): F[Response[T]]

Type parameters

R

The capabilities required by the request. This must be a subset of the the capabilities supported by the backend (which always includes Effect[F]).

Attributes

Definition Classes

Inherited methods

override def close(): F[Unit]

Attributes

Definition Classes
Inherited from:
HttpClientBackend

Inherited fields

val streams: Streams[S]

Attributes

Inherited from:
HttpClientBackend
Generated with