Copyright	(c) digitally induced GmbH 2020
Safe Haskell	None
Language	GHC2021

IHP.Router.Types

Description

Synopsis

data ControllerRoute application
- = ControllerRouteMap !(HashMap ByteString (application -> Application)) (Parser Application)
- | ControllerRouteParser !(Parser Application)
data TypedAutoRouteError
- = BadType {
  - expectedType :: !ByteString
  - value :: !(Maybe ByteString)
  - field :: !ByteString
  }
- | TooFewArguments
- | NotMatched
- | NoConstructorMatched {
  - expectedType :: !ByteString
  - value :: !(Maybe ByteString)
  - field :: !ByteString
  }
data UnexpectedMethodException = UnexpectedMethodException {
- allowedMethods :: [StdMethod]
- method :: StdMethod
}

Documentation

data ControllerRoute application Source #

A controller route entry — either a pre-built HashMap for O(1) dispatch, or a custom Attoparsec parser for dynamic URL patterns.

ControllerRouteMap carries both an auto-route HashMap and a fallback parser for custom routes. ControllerRouteParser wraps standalone parsers like get, post, webSocketApp, startPage, etc.

frontControllerToWAIApp scans all ControllerRouteMap HashMaps directly (no Attoparsec) for O(1) dispatch, and only falls back to Attoparsec for custom/dynamic route parsers.

Constructors

ControllerRouteMap !(HashMap ByteString (application -> Application)) (Parser Application)	Auto-route HashMap + custom routes fallback parser (lazy — only evaluated on HashMap miss)
ControllerRouteParser !(Parser Application)	Custom route parser (for get, post, webSocketApp, startPage, etc.)

data TypedAutoRouteError Source #

Constructors

BadType
Fields expectedType :: !ByteString value :: !(Maybe ByteString) field :: !ByteString
TooFewArguments
NotMatched
NoConstructorMatched	Thrown when `parseUUIDArgument`, `parseIntArgument`, etc. get passed an invalid value Let's say we have a `ShowProjectAction { id :: Id Project }`. When opening `/ShowProject?projectId=ab55d579-80cd-4608-9a8f-c76dea6c2332` everything is fine. But when opening `/ShowProject?projectId=not-an-uuid` this exception will be thrown.
Fields expectedType :: !ByteString value :: !(Maybe ByteString) field :: !ByteString

Instances

Instances details

Exception TypedAutoRouteError Source #
Instance details Defined in IHP.Router.Types Methods toException :: TypedAutoRouteError -> SomeException # fromException :: SomeException -> Maybe TypedAutoRouteError # displayException :: TypedAutoRouteError -> String # backtraceDesired :: TypedAutoRouteError -> Bool #
Show TypedAutoRouteError Source #
Instance details Defined in IHP.Router.Types Methods showsPrec :: Int -> TypedAutoRouteError -> ShowS # show :: TypedAutoRouteError -> String # showList :: [TypedAutoRouteError] -> ShowS #

data UnexpectedMethodException Source #

Thrown e.g. a CreateProjectAction is called from a GET request

Constructors

UnexpectedMethodException
Fields allowedMethods :: [StdMethod] method :: StdMethod

Instances

Instances details

Exception UnexpectedMethodException Source #
Instance details Defined in IHP.Router.Types Methods toException :: UnexpectedMethodException -> SomeException # fromException :: SomeException -> Maybe UnexpectedMethodException # displayException :: UnexpectedMethodException -> String # backtraceDesired :: UnexpectedMethodException -> Bool #
Show UnexpectedMethodException Source #
Instance details Defined in IHP.Router.Types Methods showsPrec :: Int -> UnexpectedMethodException -> ShowS # show :: UnexpectedMethodException -> String # showList :: [UnexpectedMethodException] -> ShowS #