Web.Routing.Combinators

Documentation

data PathState

Constructors

Open

Closed

data Path (as :: [*]) (pathState :: PathState) where

Constructors

Empty :: Path '[] 'Open

StaticCons :: Text -> Path as ps -> Path as ps

VarCons :: (FromHttpApiData a, Typeable a) => Path as ps -> Path (a ': as) ps

Wildcard :: Path as 'Open -> Path (Text ': as) 'Closed

Instances

(a ~ ('[] :: [Type]), pathState ~ 'Open) => IsString (Path a pathState)

Defined in Web.Routing.Combinators

Methods

fromString :: String -> Path a pathState

toInternalPath :: Path as pathState -> PathInternal as

type Var a = Path (a ': '[]) 'Open

data AltVar a b

A variant of Either with a FromHttpApiData definition that tries both branches without a prefix. Useful to define routes with vars that should work with different types.

Constructors

AvLeft a

AvRight b

Instances

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

Defined in Web.Routing.Combinators

Methods

(==) :: AltVar a b -> AltVar a b -> Bool

(/=) :: AltVar a b -> AltVar a b -> Bool

(Ord a, Ord b) => Ord (AltVar a b)

Defined in Web.Routing.Combinators

Methods

compare :: AltVar a b -> AltVar a b -> Ordering

(<) :: AltVar a b -> AltVar a b -> Bool

(<=) :: AltVar a b -> AltVar a b -> Bool

(>) :: AltVar a b -> AltVar a b -> Bool

(>=) :: AltVar a b -> AltVar a b -> Bool

max :: AltVar a b -> AltVar a b -> AltVar a b

min :: AltVar a b -> AltVar a b -> AltVar a b

(Read a, Read b) => Read (AltVar a b)

Defined in Web.Routing.Combinators

Methods

readsPrec :: Int -> ReadS (AltVar a b)

readList :: ReadS [AltVar a b]

readPrec :: ReadPrec (AltVar a b)

readListPrec :: ReadPrec [AltVar a b]

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

Defined in Web.Routing.Combinators

Methods

showsPrec :: Int -> AltVar a b -> ShowS

show :: AltVar a b -> String

showList :: [AltVar a b] -> ShowS

(FromHttpApiData a, FromHttpApiData b) => FromHttpApiData (AltVar a b)

Defined in Web.Routing.Combinators

Methods

parseUrlPiece :: Text -> Either Text (AltVar a b)

parseHeader :: ByteString -> Either Text (AltVar a b)

parseQueryParam :: Text -> Either Text (AltVar a b)

var :: (Typeable a, FromHttpApiData a) => Path (a ': '[]) 'Open

A route parameter

static :: String -> Path '[] 'Open

A static route piece

root :: Path '[] 'Open

The root of a path piece. Use to define a handler for "/"

wildcard :: Path '[Text] 'Closed

Matches the rest of the route. Should be the last part of the path.

(</>) :: Path as 'Open -> Path bs ps2 -> Path (Append as bs) ps2

pathToRep :: Path as ps -> Rep as

renderRoute :: AllHave ToHttpApiData as => Path as 'Open -> HVect as -> Text

renderRoute' :: AllHave ToHttpApiData as => Path as 'Open -> HVect as -> [Text]