Network.Wai.Routing.Predicate.Predicate

Documentation

type Delta = Double

Delta is a measure of distance. It is (optionally) used in predicates that evaluate to T but not uniquely so, i.e. different evaluations of T are possible and they may have a different "fitness".

An example is content-negotiation. A HTTP request may specify a preference list of various media-types. A predicate matching one specific media-type evaluates to T, but other media-types may match even better. To represent this ambivalence, the predicate will include a delta value which can be used to decide which of the matching predicates should be preferred.

data Boolean f t

A Bool-like type where each branch True or False carries some meta-data which is threaded through Predicate evaluation.

Constructors

F f

logical False with some meta-data

T Delta t

logical True with some meta-data

Instances

(Eq f, Eq t) => Eq (Boolean f t)

(Show f, Show t) => Show (Boolean f t)

class Predicate p a where

The Predicate class declares the function apply which evaluates the predicate against some value, returning a value of type Boolean. Besides being parameterised over predicate type and predicate parameter, the class is also parameterised over the actual types of T's and F's meta-data.

Associated Types

type FVal p

type TVal p

Methods

apply :: p -> a -> Boolean (FVal p) (TVal p)

Instances

Predicate HasCapture Req

Predicate HasCookie Req

Predicate HasHdr Req

Predicate HasQuery Req

Predicate HasParam Req

Predicate a b => Predicate (Opt a) b

Predicate (GetRequest a) Req

FromByteString a => Predicate (Capture a) Req

FromByteString a => Predicate (Cookie a) Req

FromByteString a => Predicate (Hdr a) Req

FromByteString a => Predicate (Query a) Req

FromByteString a => Predicate (Param a) Req

Predicate a b => Predicate (PMapF a f) b

Predicate a b => Predicate (PMapT a t) b

(Predicate a b, ~ * d (TVal a)) => Predicate (Def d a) b

(Predicate a c, Predicate b c, ~ * (FVal a) (FVal b)) => Predicate (:&: a b) c

(Predicate a c, Predicate b c, ~ * (FVal a) (FVal b)) => Predicate (:||: a b) c

(Predicate a c, Predicate b c, ~ * (TVal a) (TVal b), ~ * (FVal a) (FVal b)) => Predicate (:|: a b) c

Predicate (Fail f t) a

Predicate (Const f t) a

(SingI Symbol t, SingI Symbol s) => Predicate (Accept t s) Req

(SingI Symbol t, SingI Symbol s) => Predicate (ContentType t s) Req

Predicate a b => Predicate (PMap a f t) b

data a :|: b

A Predicate instance corresponding to the logical OR connective of two Predicates. It requires the meta-data of each True branch to be of the same type.

If both arguments evaluate to T the one with the smaller Delta will be preferred, or--if equal--the left-hand argument.

Constructors

a :|: b

Instances

(Predicate a c, Predicate b c, ~ * (TVal a) (TVal b), ~ * (FVal a) (FVal b)) => Predicate (:|: a b) c

data a :&: b

A Predicate instance corresponding to the logical AND connective of two Predicates.

Constructors

a :&: b

Instances

(Predicate a c, Predicate b c, ~ * (FVal a) (FVal b)) => Predicate (:&: a b) c

data a :||: b

A Predicate instance corresponding to the logical OR connective of two Predicates. The meta-data of each True branch can be of different types.

If both arguments evaluate to T the one with the smaller Delta will be preferred, or--if equal--the left-hand argument.

Constructors

a :||: b

Instances

(Predicate a c, Predicate b c, ~ * (FVal a) (FVal b)) => Predicate (:||: a b) c

data a ::: b

Data-type used for tupling-up the results of :&:.

Constructors

a ::: b

Instances

(Eq a, Eq b) => Eq (::: a b)

(Show a, Show b) => Show (::: a b)

type :+: a b = Either a b

data Const f t

A Predicate instance which always returns T with the given value as T's meta-data.

Instances

Predicate (Const f t) a

data Fail f t

A Predicate instance which always returns F with the given value as F's meta-data.

Instances

Predicate (Fail f t) a

data Opt a

A Predicate modifier which makes the underlying predicate optional, i.e. the TVal becomes a Maybe and in the failure-case Nothing is returned.

Instances

Predicate a b => Predicate (Opt a) b

data Def d a

A Predicate modifier which returns as TVal the provided default value if the underlying predicate fails.

Instances

(Predicate a b, ~ * d (TVal a)) => Predicate (Def d a) b

data PMap a f t

A Predicate function, i.e. a function of the underlying predicate's result.

Instances

Predicate a b => Predicate (PMap a f t) b

data PMapT a t

Like PMap but a function of the underlying predicate's TVal.

Instances

Predicate a b => Predicate (PMapT a t) b

data PMapF a f

Like PMap but a function of the underlying predicate's FVal.

Instances

Predicate a b => Predicate (PMapF a f) b

constant :: t -> Const f t

failure :: f -> Fail f t

true :: Const a ()

opt :: a -> Opt a

def :: d -> a -> Def d a

pmap :: (Boolean (FVal a) (TVal a) -> Boolean f t) -> a -> PMap a f t

pmapT :: (TVal a -> Boolean (FVal a) t) -> a -> PMapT a t

pmapF :: (FVal a -> Boolean f (TVal a)) -> a -> PMapF a f

with :: (Monad m, Predicate p a) => p -> a -> (TVal p -> m ()) -> m ()

The with function will invoke the given function only if the predicate p applied to the test value a evaluates to T.