Copyright	(C) 2016-2018 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <djohnson.m@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.Router

Description

Synopsis

runRoute :: HasRouter layout => Proxy layout -> RouteT layout (m -> a) -> (m -> URI) -> m -> Either RoutingError a
route :: HasRouter layout => Proxy layout -> RouteT layout a -> URI -> Either RoutingError a
class HasRouter layout
type family RouteT layout a :: *
data RoutingError = Fail

Documentation

runRoute :: HasRouter layout => Proxy layout -> RouteT layout (m -> a) -> (m -> URI) -> m -> Either RoutingError a Source #

route :: HasRouter layout => Proxy layout -> RouteT layout a -> URI -> Either RoutingError a Source #

Use a handler to mkRouter a location, represented as a String. All handlers must, in the end, return m a. routeLoc will choose a mkRouter and return its result.

class HasRouter layout Source #

This is similar to the HasServer class from servant-server. It is the class responsible for making API combinators routable. RouteT is used to build up the handler types. Router is returned, to be interpretted by routeLoc.

Minimal complete definition

mkRouter

Instances

HasRouter Raw Source #	Raw
Instance details Defined in Miso.Router Associated Types type RouteT Raw a :: * Source # Methods mkRouter :: Proxy Raw -> Proxy a -> RouteT Raw a -> Router a
HasRouter (View a :: *) Source #	View
Instance details Defined in Miso.Router Associated Types type RouteT (View a) a :: * Source # Methods mkRouter :: Proxy (View a) -> Proxy a0 -> RouteT (View a) a0 -> Router a0
(HasRouter x, HasRouter y) => HasRouter (x :<\|> y :: *) Source #	Alternative
Instance details Defined in Miso.Router Associated Types type RouteT (x :<\|> y) a :: * Source # Methods mkRouter :: Proxy (x :<\|> y) -> Proxy a -> RouteT (x :<\|> y) a -> Router a
(HasRouter sublayout, FromHttpApiData x, KnownSymbol sym) => HasRouter (QueryParam sym x :> sublayout :: *) Source #	QueryParam
Instance details Defined in Miso.Router Associated Types type RouteT (QueryParam sym x :> sublayout) a :: * Source # Methods mkRouter :: Proxy (QueryParam sym x :> sublayout) -> Proxy a -> RouteT (QueryParam sym x :> sublayout) a -> Router a
(HasRouter sublayout, FromHttpApiData x, KnownSymbol sym) => HasRouter (QueryParams sym x :> sublayout :: *) Source #	QueryParams
Instance details Defined in Miso.Router Associated Types type RouteT (QueryParams sym x :> sublayout) a :: * Source # Methods mkRouter :: Proxy (QueryParams sym x :> sublayout) -> Proxy a -> RouteT (QueryParams sym x :> sublayout) a -> Router a
(HasRouter sublayout, KnownSymbol sym) => HasRouter (QueryFlag sym :> sublayout :: *) Source #	QueryFlag
Instance details Defined in Miso.Router Associated Types type RouteT (QueryFlag sym :> sublayout) a :: * Source # Methods mkRouter :: Proxy (QueryFlag sym :> sublayout) -> Proxy a -> RouteT (QueryFlag sym :> sublayout) a -> Router a
(HasRouter sublayout, FromHttpApiData x) => HasRouter (Capture sym x :> sublayout :: *) Source #	Capture
Instance details Defined in Miso.Router Associated Types type RouteT (Capture sym x :> sublayout) a :: * Source # Methods mkRouter :: Proxy (Capture sym x :> sublayout) -> Proxy a -> RouteT (Capture sym x :> sublayout) a -> Router a
(HasRouter sublayout, KnownSymbol path) => HasRouter (path :> sublayout :: *) Source #	Path
Instance details Defined in Miso.Router Associated Types type RouteT (path :> sublayout) a :: * Source # Methods mkRouter :: Proxy (path :> sublayout) -> Proxy a -> RouteT (path :> sublayout) a -> Router a
HasRouter (Verb m s c a :: *) Source #	Verb
Instance details Defined in Miso.Router Associated Types type RouteT (Verb m s c a) a :: * Source # Methods mkRouter :: Proxy (Verb m s c a) -> Proxy a0 -> RouteT (Verb m s c a) a0 -> Router a0

type family RouteT layout a :: * Source #

A mkRouter handler.

Instances

type RouteT Raw x Source #
Instance details Defined in Miso.Router type RouteT Raw x = x
type RouteT (View a :: *) x Source #
Instance details Defined in Miso.Router type RouteT (View a :: *) x = x
type RouteT (x :<\|> y :: *) a Source #
Instance details Defined in Miso.Router type RouteT (x :<\|> y :: *) a = RouteT x a :<\|> RouteT y a
type RouteT (QueryParam sym x :> sublayout :: *) a Source #
Instance details Defined in Miso.Router type RouteT (QueryParam sym x :> sublayout :: *) a = Maybe x -> RouteT sublayout a
type RouteT (QueryParams sym x :> sublayout :: *) a Source #
Instance details Defined in Miso.Router type RouteT (QueryParams sym x :> sublayout :: *) a = [x] -> RouteT sublayout a
type RouteT (QueryFlag sym :> sublayout :: *) a Source #
Instance details Defined in Miso.Router type RouteT (QueryFlag sym :> sublayout :: *) a = Bool -> RouteT sublayout a
type RouteT (Capture sym x :> sublayout :: *) a Source #
Instance details Defined in Miso.Router type RouteT (Capture sym x :> sublayout :: *) a = x -> RouteT sublayout a
type RouteT (path :> sublayout :: *) a Source #
Instance details Defined in Miso.Router type RouteT (path :> sublayout :: *) a = RouteT sublayout a
type RouteT (Verb m s c a :: *) x Source #
Instance details Defined in Miso.Router type RouteT (Verb m s c a :: *) x = x

data RoutingError Source #

When routing, the router may fail to match a location.

Constructors

Fail

Instances

Eq RoutingError Source #
Instance details Defined in Miso.Router Methods (==) :: RoutingError -> RoutingError -> Bool # (/=) :: RoutingError -> RoutingError -> Bool #
Ord RoutingError Source #
Instance details Defined in Miso.Router Methods compare :: RoutingError -> RoutingError -> Ordering # (<) :: RoutingError -> RoutingError -> Bool # (<=) :: RoutingError -> RoutingError -> Bool # (>) :: RoutingError -> RoutingError -> Bool # (>=) :: RoutingError -> RoutingError -> Bool # max :: RoutingError -> RoutingError -> RoutingError # min :: RoutingError -> RoutingError -> RoutingError #
Show RoutingError Source #
Instance details Defined in Miso.Router Methods showsPrec :: Int -> RoutingError -> ShowS # show :: RoutingError -> String # showList :: [RoutingError] -> ShowS #