Web.Minion.Router.Internal

Documentation

type Router = Router' Void

If you don't care about introspection

type MiddlewareM m = ApplicationM m -> ApplicationM m

type MakeError = Status -> ByteString -> ServerError

type ValueCombinator i v ts m = Router' i (ts :+ v) m -> Router' i ts m

type Combinator i ts m = Router' i ts m -> Router' i ts m

data Router' i (ts :: Type) m where

Constructors

Piece

Fields

• :: Text

  .

• -> Router' i ts m
• -> Router' i ts m

QueryParam

Fields

• :: forall a presence parsing m ts i. (Introspection i QueryParam a, IsRequired presence, IsLenient parsing)
• => ByteString

  Query param name

• -> (MakeError -> Maybe (Maybe ByteString) -> m (Arg presence parsing a))

  Parse query param Outer Maybe -- is there key Inner Maybe -- is there value

• -> Router' i (ts :+ WithQueryParam presence parsing m a) m
• -> Router' i ts m

Captures

Fields

• :: forall a ts m i. Introspection i Captures a
• => (MakeError -> [Text] -> m [a])

  Parse pieces

• -> Text

  Placeholder

• -> Router' i (ts :+ WithPieces a) m
• -> Router' i ts m

Capture

Fields

• :: forall a ts m i. Introspection i Capture a
• => (MakeError -> Text -> m a)

  Parse piece

• -> Text

  Placeholder

• -> Router' i (ts :+ WithPiece a) m
• -> Router' i ts m

Middleware :: MiddlewareM m -> Router' i ts m -> Router' i ts m

Header

Fields

• :: forall a presence parsing m ts i. (Introspection i Header a, IsRequired presence, IsLenient parsing)
• => HeaderName
• -> (MakeError -> [ByteString] -> m (Arg presence parsing a))

  Parse header

• -> Router' i (ts :+ WithHeader presence parsing m a) m
• -> Router' i ts m

Request

Fields

• :: forall r m i ts. (Introspection i Request r, IsRequest r)
• => (ErrorBuilder -> Request -> m r)

  .

• -> Router' i (ts :+ WithReq m r) m
• -> Router' i ts m

Alt

Fields

• :: [Router' i ts m]

  Sub routes

• -> Router' i ts m

Handle

Fields

• :: forall o m ts i st. (HandleArgs ts st m, ToResponse m o, CanRespond o, Introspection i Response o)
• => Method

  Handled HTTP method

• -> (HList (DelayedArgs st) -> m o)
• -> Router' i ts m

Description

Fields

• :: Introspection i Description desc
• => desc

  .

• -> Router' i ts m
• -> Router' i ts m

MapArgs :: forall m ts ts' i. (RHList ts -> RHList ts') -> Router' i ts' m -> Router' i ts m

HideIntrospection :: forall i' i ts m. Router' i ts m -> Router' i' ts m

Instances

IsString (Combinator i ts m)

Defined in Web.Minion.Router.Internal

Methods

fromString :: String -> Combinator i ts m

Monoid (Router' i ts r)

Defined in Web.Minion.Router.Internal

Methods

mempty :: Router' i ts r

mappend :: Router' i ts r -> Router' i ts r -> Router' i ts r

mconcat :: [Router' i ts r] -> Router' i ts r

Semigroup (Router' i ts r)

Defined in Web.Minion.Router.Internal

Methods

(<>) :: Router' i ts r -> Router' i ts r -> Router' i ts r

sconcat :: NonEmpty (Router' i ts r) -> Router' i ts r

stimes :: Integral b => b -> Router' i ts r -> Router' i ts r

IsList (Router' i ts r)

Defined in Web.Minion.Router.Internal

Associated Types

type Item (Router' i ts r)

Methods

fromList :: [Item (Router' i ts r)] -> Router' i ts r

fromListN :: Int -> [Item (Router' i ts r)] -> Router' i ts r

toList :: Router' i ts r -> [Item (Router' i ts r)]

type Item (Router' i ts r)

Defined in Web.Minion.Router.Internal

type Item (Router' i ts r) = Router' i ts r

route :: forall m ts i. (MonadIO m, MonadCatch m) => ErrorBuilders -> RoutingState -> RHList ts -> Router' i ts m -> ApplicationM m

routeHandle :: forall m o ts st. (MonadIO m, ToResponse m o, CanRespond o, HandleArgs ts st m) => [Text] -> RHList ts -> Method -> (HList (DelayedArgs st) -> m o) -> ApplicationM m

goThrough :: (MonadIO m, MonadCatch m) => [m b] -> m b

throwMIO :: (Exception e, MonadIO m) => e -> m a

checkHandler :: MonadIO f => Request -> [Text] -> Method -> f ()

lookupHeader :: Request -> HeaderName -> [ByteString]

smartPiece :: String -> Combinator i ts m

newtype RoutingState

Constructors

RoutingState

Fields

• path :: [Text]

type ApplicationM m = Request -> (Response -> IO ResponseReceived) -> m ResponseReceived

Application lifted to m

makeHandle :: forall f o m ts i st. (HandleArgs ts st m, ToResponse m (f o), CanRespond (f o), Introspection i Response (f o)) => Method -> (o -> f o) -> (DelayedArgs st ~> m o) -> Router' i ts m