Polysemy.Http.Effect.Http

Documentation

data Http c :: Effect where

The main effect for HTTP requests. The parameter c determines the representation of raw chunks.

Constructors

Response :: Request -> (Response c -> m a) -> Http c m (Either HttpError a)

Request :: Request -> Http c m (Either HttpError (Response LByteString))

Stream :: Request -> (Response c -> m a) -> Http c m (Either HttpError a)

ConsumeChunk :: c -> Http c m (Either HttpError ByteString)

Internal action for streaming transfers.

Instances

type DefiningModule Http

Defined in Polysemy.Http.Effect.Http

type DefiningModule Http = "Polysemy.Http.Effect.Http"

response :: forall c r a. Member (Http c) r => Request -> (Response c -> Sem r a) -> Sem r (Either HttpError a)

Bracket a higher-order action with a Response that has been opened while its body hasn't been fetched.

request :: forall c r. Member (Http c) r => Request -> Sem r (Either HttpError (Response LByteString))

Synchronously run an HTTP request and return the response.

stream :: forall c r a. Member (Http c) r => Request -> (Response c -> Sem r a) -> Sem r (Either HttpError a)

Open a connection without consuming data and pass the response to a handler for custom transmission. The intended purpose is to allow streaming transfers.