WebGear.Trait.Path

Traits related to the route path of a request.

Documentation

data Path (s :: Symbol)

A path component which is literally matched against the request but discarded after that.

Instances

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

Defined in WebGear.Trait.Path

Associated Types

type Val (Path s) Request

type Fail (Path s) Request

Methods

check :: Request -> m (CheckResult (Path s) Request)

type Val (Path s :: Type) Request

Defined in WebGear.Trait.Path

type Val (Path s :: Type) Request = ()

type Fail (Path s :: Type) Request

Defined in WebGear.Trait.Path

type Fail (Path s :: Type) Request = ()

data PathVar tag (val :: Type)

A path variable that is extracted and converted to a value of type val. The tag is usually a type-level symbol (string) to uniquely identify this variable.

Instances

(FromHttpApiData val, Monad m) => Trait (PathVar tag val :: Type) Request m

Defined in WebGear.Trait.Path

Associated Types

type Val (PathVar tag val) Request

type Fail (PathVar tag val) Request

Methods

check :: Request -> m (CheckResult (PathVar tag val) Request)

type Val (PathVar tag val :: Type) Request

Defined in WebGear.Trait.Path

type Val (PathVar tag val :: Type) Request = val

type Fail (PathVar tag val :: Type) Request

Defined in WebGear.Trait.Path

type Fail (PathVar tag val :: Type) Request = PathVarFail

data PathVarFail

Failure to extract a PathVar

Constructors

PathVarNotFound

PathVarParseError Text

Instances

Eq PathVarFail

Defined in WebGear.Trait.Path

Methods

(==) :: PathVarFail -> PathVarFail -> Bool

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

Read PathVarFail

Defined in WebGear.Trait.Path

Methods

readsPrec :: Int -> ReadS PathVarFail

readList :: ReadS [PathVarFail]

readPrec :: ReadPrec PathVarFail

readListPrec :: ReadPrec [PathVarFail]

Show PathVarFail

Defined in WebGear.Trait.Path

Methods

showsPrec :: Int -> PathVarFail -> ShowS

show :: PathVarFail -> String

showList :: [PathVarFail] -> ShowS