WebGear.Trait.Header

Traits related to HTTP headers.

Documentation

data Header (s :: Symbol) (t :: Type)

A Trait for capturing a header with name s in a request or response and convert it to some type t via FromHttpApiData.

Instances

(KnownSymbol s, FromHttpApiData t, Monad m) => Trait (Header s t :: Type) Request m

Defined in WebGear.Trait.Header

Associated Types

type Val (Header s t) Request

type Fail (Header s t) Request

Methods

check :: Request -> m (CheckResult (Header s t) Request)

type Val (Header s t :: Type) Request

Defined in WebGear.Trait.Header

type Val (Header s t :: Type) Request = t

type Fail (Header s t :: Type) Request

Defined in WebGear.Trait.Header

type Fail (Header s t :: Type) Request = HeaderFail

data HeaderFail

Failure in extracting a header value

Constructors

HeaderNotFound

HeaderParseError Text

Instances

Eq HeaderFail

Defined in WebGear.Trait.Header

Methods

(==) :: HeaderFail -> HeaderFail -> Bool

(/=) :: HeaderFail -> HeaderFail -> Bool

Read HeaderFail

Defined in WebGear.Trait.Header

Methods

readsPrec :: Int -> ReadS HeaderFail

readList :: ReadS [HeaderFail]

readPrec :: ReadPrec HeaderFail

readListPrec :: ReadPrec [HeaderFail]

Show HeaderFail

Defined in WebGear.Trait.Header

Methods

showsPrec :: Int -> HeaderFail -> ShowS

show :: HeaderFail -> String

showList :: [HeaderFail] -> ShowS

data HeaderMatch (s :: Symbol) (t :: Symbol)

A Trait for ensuring that a header named s has value t.

Instances

(KnownSymbol s, KnownSymbol t, Monad m) => Trait (HeaderMatch s t :: Type) Request m

Defined in WebGear.Trait.Header

Associated Types

type Val (HeaderMatch s t) Request

type Fail (HeaderMatch s t) Request

Methods

check :: Request -> m (CheckResult (HeaderMatch s t) Request)

type Val (HeaderMatch s t :: Type) Request

Defined in WebGear.Trait.Header

type Val (HeaderMatch s t :: Type) Request = ByteString

type Fail (HeaderMatch s t :: Type) Request

Defined in WebGear.Trait.Header

type Fail (HeaderMatch s t :: Type) Request = HeaderMismatch

data HeaderMismatch

Failure in extracting a header value

Constructors

HeaderMismatch

Fields

• expectedHeader :: ByteString
• actualHeader :: Maybe ByteString

Instances

Eq HeaderMismatch

Defined in WebGear.Trait.Header

Methods

(==) :: HeaderMismatch -> HeaderMismatch -> Bool

(/=) :: HeaderMismatch -> HeaderMismatch -> Bool

Read HeaderMismatch

Defined in WebGear.Trait.Header

Methods

readsPrec :: Int -> ReadS HeaderMismatch

readList :: ReadS [HeaderMismatch]

readPrec :: ReadPrec HeaderMismatch

readListPrec :: ReadPrec [HeaderMismatch]

Show HeaderMismatch

Defined in WebGear.Trait.Header

Methods

showsPrec :: Int -> HeaderMismatch -> ShowS

show :: HeaderMismatch -> String

showList :: [HeaderMismatch] -> ShowS