Module

Erl.Cowboy.Req

Package
erl-cowboy
Repository
purerl/purescript-erl-cowboy

Bindings for cowboy_req

The Req type (corresponding to req()) is core to the use of cowboy, containing information about request and response. Many functions operating on Req are pure, producing an updated Req if required to update some fields, e.g. when setting a header, but others produce a result in Effect as even though they may update the Req, they also cause side-effects such as sending traffic on the network (eg reply).

#StatusCode Source

newtype StatusCode

Constructors

#Req Source

data Req :: Type

#reply Source

reply :: StatusCode -> Headers -> IOData -> Req -> Effect Req

Send the reply including the given body content (cowboy_req:reply/4)

#replyWithoutBody Source

replyWithoutBody :: StatusCode -> Headers -> Req -> Effect Req

Send the reply without setting the body (cowboy_req:reply/3)

#replyWithFile Source

replyWithFile :: StatusCode -> Headers -> String -> Req -> Effect Req

Send the reply including a file as the body

#replyStatus Source

replyStatus :: StatusCode -> Req -> Effect Req

Send the reply with already set headers and body (cowboy_req:reply/2)

#method Source

method :: Req -> String

#Version Source

data Version

Constructors

#version Source

version :: Req -> Version

#scheme Source

scheme :: Req -> String

#binding Source

binding :: forall a. Atom -> Req -> Maybe a

#bindingWithDefault Source

bindingWithDefault :: forall a. Atom -> Req -> a -> a

#port Source

port :: Req -> Int

#headers Source

headers :: Req -> Headers

#ReadUrlEncodedBodyResult Source

data ReadUrlEncodedBodyResult

Constructors

#setCookie Source

setCookie :: String -> String -> Req -> Req

#setCookieWithOpts Source

setCookieWithOpts :: String -> String -> CookieOpts -> Req -> Req

#CookieOpts Source

type CookieOpts = { domain :: String, http_only :: Boolean, max_age :: Int, path :: String, same_site :: Atom, secure :: Boolean }

#setHeader Source

setHeader :: String -> String -> Req -> Req

#setBody Source

setBody :: String -> Req -> Req

Set response body. As should be apparent from the type, this does not actually send the body but merely sets it in the Req, the body is sent once reply is called.

#streamBody Source

streamBody :: IOData -> Req -> Effect Unit

#streamBodyFinal Source

streamBodyFinal :: IOData -> Req -> Effect Unit
Modules
Attribute
Cowboy.Static
Erl.Cowboy
Erl.Cowboy.Handler
Erl.Cowboy.Handlers.Common
Erl.Cowboy.Handlers.Loop
Erl.Cowboy.Handlers.Rest
Erl.Cowboy.Handlers.Simple
Erl.Cowboy.Handlers.WebSocket
Erl.Cowboy.Req
Erl.Cowboy.Req.Monad
Erl.Cowboy.Routes