webgear-core-1.2.0: Composable, type-safe library to build HTTP APIs
Safe HaskellSafe-Inferred
LanguageHaskell2010

WebGear.Core.Request

Description

Requests processed by handlers.

Synopsis

WebGear Request

newtype Request Source #

A request processed by a handler

Constructors

Request 

Fields

Instances

Instances details
Trait Method Request Source # 
Instance details

Defined in WebGear.Core.Trait.Method

Associated Types

type Attribute Method Request Source #

Trait Path Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

Associated Types

type Attribute Path Request Source #

Trait PathEnd Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

Associated Types

type Attribute PathEnd Request Source #

TraitAbsence Method Request Source # 
Instance details

Defined in WebGear.Core.Trait.Method

Associated Types

type Absence Method Request Source #

TraitAbsence Path Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

Associated Types

type Absence Path Request Source #

TraitAbsence PathEnd Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

Associated Types

type Absence PathEnd Request Source #

Trait (Body mt t) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Body

Associated Types

type Attribute (Body mt t) 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 (Body mt t) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Body

Associated Types

type Absence (Body mt 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 (Cookie 'Optional name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

Associated Types

type Attribute (Cookie 'Optional name val) Request Source #

Trait (Cookie 'Required name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

Associated Types

type Attribute (Cookie 'Required name val) Request Source #

TraitAbsence (Cookie 'Optional name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

Associated Types

type Absence (Cookie 'Optional name val) Request Source #

TraitAbsence (Cookie 'Required name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

Associated Types

type Absence (Cookie 'Required name val) Request Source #

Trait (RequestHeader 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Attribute (RequestHeader 'Optional 'Lenient name val) Request Source #

Trait (RequestHeader 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Attribute (RequestHeader 'Optional 'Strict name val) Request Source #

Trait (RequestHeader 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Attribute (RequestHeader 'Required 'Lenient name val) Request Source #

Trait (RequestHeader 'Required 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Attribute (RequestHeader 'Required '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 #

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 '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 '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 #

TraitAbsence (RequestHeader 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Absence (RequestHeader 'Optional 'Lenient name val) Request Source #

TraitAbsence (RequestHeader 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Absence (RequestHeader 'Optional 'Strict name val) Request Source #

TraitAbsence (RequestHeader 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Absence (RequestHeader 'Required 'Lenient name val) Request Source #

TraitAbsence (RequestHeader 'Required 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

Associated Types

type Absence (RequestHeader 'Required '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 #

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 '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 '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 #

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 #

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 (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 (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 #

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 #

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 (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 (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 #

type Absence Method Request Source # 
Instance details

Defined in WebGear.Core.Trait.Method

type Absence Path Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Absence Path Request = ()
type Absence PathEnd Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Attribute Method Request Source # 
Instance details

Defined in WebGear.Core.Trait.Method

type Attribute Path Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Attribute PathEnd Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Prerequisite Method ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Method

type Prerequisite Path ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Prerequisite PathEnd ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Absence (Body mt t) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Body

type Absence (Body mt t) Request = Text
type Absence (PathVar tag val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Attribute (Body mt t) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Body

type Attribute (Body mt t) Request = t
type Attribute (PathVar tag val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Attribute (PathVar tag val) Request = val
type Absence (Cookie 'Optional name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

type Absence (Cookie 'Required name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

type Attribute (Cookie 'Optional name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

type Attribute (Cookie 'Optional name val) Request = Maybe val
type Attribute (Cookie 'Required name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

type Attribute (Cookie 'Required name val) Request = val
type Absence (RequestHeader 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Absence (RequestHeader 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Absence (RequestHeader 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Absence (RequestHeader 'Required 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Absence (QueryParam 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Absence (QueryParam 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Absence (QueryParam 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Absence (QueryParam 'Required 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Attribute (RequestHeader 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Attribute (RequestHeader 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Attribute (RequestHeader 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Attribute (RequestHeader 'Required 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Attribute (QueryParam 'Optional 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Attribute (QueryParam 'Optional 'Strict name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Attribute (QueryParam 'Required 'Lenient name val) Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

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 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 Absence (BasicAuth' 'Required scheme m e a) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Auth.Basic

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 (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 Attribute (BasicAuth' 'Optional scheme m e a) Request Source # 
Instance details

Defined in WebGear.Core.Trait.Auth.Basic

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 (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 (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 Prerequisite (Body mt t) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Body

type Prerequisite (Body mt t) ts Request = ()
type Prerequisite (PathVar tag val) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Path

type Prerequisite (PathVar tag val) ts Request = ()
type Prerequisite (Cookie e name val) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Cookie

type Prerequisite (Cookie e name val) ts Request = HasTrait (RequestHeader e 'Strict "Cookie" Text) ts
type Prerequisite (RequestHeader e p name val) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Header

type Prerequisite (RequestHeader e p name val) ts Request = ()
type Prerequisite (QueryParam e p name val) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.QueryParam

type Prerequisite (QueryParam e p name val) ts Request = ()
type Prerequisite (BasicAuth' x scheme m e a) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Auth.Basic

type Prerequisite (BasicAuth' x scheme m e a) ts Request = HasTrait (AuthorizationHeader scheme) ts
type Prerequisite (JWTAuth' x scheme m e a) ts Request Source # 
Instance details

Defined in WebGear.Core.Trait.Auth.JWT

type Prerequisite (JWTAuth' x scheme m e a) ts Request = HasTrait (AuthorizationHeader scheme) ts

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

Get the value of a request header

getRequestBody :: Request -> IO ByteString Source #

Returns the entire request body as a lazy bytestring