Safe Haskell	None
Language	Haskell2010

WebGear.Core.Request

Contents

WebGear Request

Description

Requests processed by handlers.

Synopsis

newtype Request = Request {
- waiRequest :: Request
}
remoteHost :: Request -> SockAddr
httpVersion :: Request -> HttpVersion
isSecure :: Request -> Bool
requestMethod :: Request -> Method
pathInfo :: Request -> [Text]
queryString :: Request -> Query
requestHeader :: HeaderName -> Request -> Maybe ByteString
requestHeaders :: Request -> RequestHeaders
requestBodyLength :: Request -> RequestBodyLength
getRequestBodyChunk :: Request -> IO ByteString

WebGear Request

newtype Request Source #

A request processed by a handler

Constructors

Request
Fields waiRequest :: Request underlying WAI request

Instances

Instances details

TraitAbsence Method Request Source #
Instance details Defined in WebGear.Core.Trait.Method Associated Types type Absence Method Request Source #
TraitAbsence PathEnd Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Absence PathEnd Request Source #
TraitAbsence Path Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Absence Path Request Source #
Trait Method Request Source #
Instance details Defined in WebGear.Core.Trait.Method Associated Types type Attribute Method Request Source #
Trait PathEnd Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Attribute PathEnd Request Source #
Trait Path Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Attribute Path Request Source #
TraitAbsence (JSONBody t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body Associated Types type Absence (JSONBody t) Request Source #
TraitAbsence (Body t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body Associated Types type Absence (Body t) Request Source #
Trait (JSONBody t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body Associated Types type Attribute (JSONBody t) Request Source #
Trait (Body t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body Associated Types type Attribute (Body t) Request Source #
TraitAbsence (PathVar tag val) Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Absence (PathVar tag val) Request Source #
Trait (PathVar tag val) Request Source #
Instance details Defined in WebGear.Core.Trait.Path Associated Types type Attribute (PathVar tag val) Request Source #
TraitAbsence (Header 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Absence (Header 'Required 'Strict name val) Request Source #
TraitAbsence (Header 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Absence (Header 'Required 'Lenient name val) Request Source #
TraitAbsence (Header 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Absence (Header 'Optional 'Strict name val) Request Source #
TraitAbsence (Header 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Absence (Header 'Optional 'Lenient name val) Request Source #
TraitAbsence (QueryParam 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Absence (QueryParam 'Required 'Strict name val) Request Source #
TraitAbsence (QueryParam 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Absence (QueryParam 'Required 'Lenient name val) Request Source #
TraitAbsence (QueryParam 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Absence (QueryParam 'Optional 'Strict name val) Request Source #
TraitAbsence (QueryParam 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Absence (QueryParam 'Optional 'Lenient name val) Request Source #
Trait (Header 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Attribute (Header 'Required 'Strict name val) Request Source #
Trait (Header 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Attribute (Header 'Required 'Lenient name val) Request Source #
Trait (Header 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Attribute (Header 'Optional 'Strict name val) Request Source #
Trait (Header 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header Associated Types type Attribute (Header 'Optional 'Lenient name val) Request Source #
Trait (QueryParam 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Attribute (QueryParam 'Required 'Strict name val) Request Source #
Trait (QueryParam 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Attribute (QueryParam 'Required 'Lenient name val) Request Source #
Trait (QueryParam 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Attribute (QueryParam 'Optional 'Strict name val) Request Source #
Trait (QueryParam 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam Associated Types type Attribute (QueryParam 'Optional 'Lenient name val) Request Source #
TraitAbsence (JWTAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT Associated Types type Absence (JWTAuth' 'Required scheme m e a) Request Source #
TraitAbsence (JWTAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT Associated Types type Absence (JWTAuth' 'Optional scheme m e a) Request Source #
TraitAbsence (BasicAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic Associated Types type Absence (BasicAuth' 'Required scheme m e a) Request Source #
TraitAbsence (BasicAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic Associated Types type Absence (BasicAuth' 'Optional scheme m e a) Request Source #
Trait (JWTAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT Associated Types type Attribute (JWTAuth' 'Required scheme m e a) Request Source #
Trait (JWTAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT Associated Types type Attribute (JWTAuth' 'Optional scheme m e a) Request Source #
Trait (BasicAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic Associated Types type Attribute (BasicAuth' 'Required scheme m e a) Request Source #
Trait (BasicAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic Associated Types type Attribute (BasicAuth' 'Optional scheme m e a) Request Source #
type Absence Method Request Source #
Instance details Defined in WebGear.Core.Trait.Method type Absence Method Request = MethodMismatch
type Absence PathEnd Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Absence PathEnd Request = ()
type Absence Path Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Absence Path Request = ()
type Attribute Method Request Source #
Instance details Defined in WebGear.Core.Trait.Method type Attribute Method Request = StdMethod
type Attribute PathEnd Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Attribute PathEnd Request = ()
type Attribute Path Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Attribute Path Request = ()
type Absence (JSONBody t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body type Absence (JSONBody t) Request = Text
type Absence (Body t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body type Absence (Body t) Request = Text
type Attribute (JSONBody t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body type Attribute (JSONBody t) Request = t
type Attribute (Body t) Request Source #
Instance details Defined in WebGear.Core.Trait.Body type Attribute (Body t) Request = t
type Absence (PathVar tag val) Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Absence (PathVar tag val) Request = PathVarError
type Attribute (PathVar tag val) Request Source #
Instance details Defined in WebGear.Core.Trait.Path type Attribute (PathVar tag val) Request = val
type Absence (Header 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Absence (Header 'Required 'Strict name val) Request = Either HeaderNotFound HeaderParseError
type Absence (Header 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Absence (Header 'Required 'Lenient name val) Request = HeaderNotFound
type Absence (Header 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Absence (Header 'Optional 'Strict name val) Request = HeaderParseError
type Absence (Header 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Absence (Header 'Optional 'Lenient name val) Request = Void
type Absence (QueryParam 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Absence (QueryParam 'Required 'Strict name val) Request = Either ParamNotFound ParamParseError
type Absence (QueryParam 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Absence (QueryParam 'Required 'Lenient name val) Request = ParamNotFound
type Absence (QueryParam 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Absence (QueryParam 'Optional 'Strict name val) Request = ParamParseError
type Absence (QueryParam 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Absence (QueryParam 'Optional 'Lenient name val) Request = Void
type Attribute (Header 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Attribute (Header 'Required 'Strict name val) Request = val
type Attribute (Header 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Attribute (Header 'Required 'Lenient name val) Request = Either Text val
type Attribute (Header 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Attribute (Header 'Optional 'Strict name val) Request = Maybe val
type Attribute (Header 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.Header type Attribute (Header 'Optional 'Lenient name val) Request = Maybe (Either Text val)
type Attribute (QueryParam 'Required 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Attribute (QueryParam 'Required 'Strict name val) Request = val
type Attribute (QueryParam 'Required 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Attribute (QueryParam 'Required 'Lenient name val) Request = Either Text val
type Attribute (QueryParam 'Optional 'Strict name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Attribute (QueryParam 'Optional 'Strict name val) Request = Maybe val
type Attribute (QueryParam 'Optional 'Lenient name val) Request Source #
Instance details Defined in WebGear.Core.Trait.QueryParam type Attribute (QueryParam 'Optional 'Lenient name val) Request = Maybe (Either Text val)
type Absence (JWTAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT type Absence (JWTAuth' 'Required scheme m e a) Request = JWTAuthError e
type Absence (JWTAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT type Absence (JWTAuth' 'Optional scheme m e a) Request = Void
type Absence (BasicAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic type Absence (BasicAuth' 'Required scheme m e a) Request = BasicAuthError e
type Absence (BasicAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic type Absence (BasicAuth' 'Optional scheme m e a) Request = Void
type Attribute (JWTAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT type Attribute (JWTAuth' 'Required scheme m e a) Request = a
type Attribute (JWTAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.JWT type Attribute (JWTAuth' 'Optional scheme m e a) Request = Either (JWTAuthError e) a
type Attribute (BasicAuth' 'Required scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic type Attribute (BasicAuth' 'Required scheme m e a) Request = a
type Attribute (BasicAuth' 'Optional scheme m e a) Request Source #
Instance details Defined in WebGear.Core.Trait.Auth.Basic type Attribute (BasicAuth' 'Optional scheme m e a) Request = Either (BasicAuthError e) a

remoteHost :: Request -> SockAddr Source #

See remoteHost

httpVersion :: Request -> HttpVersion Source #

See httpVersion

isSecure :: Request -> Bool Source #

See isSecure

requestMethod :: Request -> Method Source #

See requestMethod

pathInfo :: Request -> [Text] Source #

See pathInfo

queryString :: Request -> Query Source #

See queryString

requestHeader :: HeaderName -> Request -> Maybe ByteString Source #

Get the value of a request header

requestHeaders :: Request -> RequestHeaders Source #

See requestHeaders

requestBodyLength :: Request -> RequestBodyLength Source #

See requestBodyLength

getRequestBodyChunk :: Request -> IO ByteString Source #

See getRequestBodyChunk

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result