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)
- | ControllerRouteTrie !RouteTrie
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
}
newtype BadHttpMethodException = BadHttpMethodException {
- method :: ByteString
}

Documentation

data ControllerRoute application Source #

A controller route entry. Three flavours:

ControllerRouteMap — the legacy AutoRoute path: a pre-built HashMap of full paths to handlers, plus a custom-routes fallback Parser.
ControllerRouteParser — standalone custom Parser (for helpers like get, post, webSocketApp, startPage, etc.).
ControllerRouteTrie — the new explicit-routes path: a pre-built trie fragment carrying method-aware, capture-aware route entries. Used by the routes quasi-quoter.

frontControllerToWAIApp first merges all ControllerRouteTrie fragments into a single RouteTrie and tries a fast, method-aware lookup against it. On no match it falls back to the legacy ControllerRouteMap HashMap scan and, finally, to Attoparsec for the remaining custom 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.)
ControllerRouteTrie !RouteTrie	Pre-built trie fragment from the `routes` DSL. Method-aware; merged into the app-wide trie at startup.

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 #

newtype BadHttpMethodException Source #

Thrown when the request uses an HTTP method that isn't part of the standard set (GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, CONNECT, TRACE).

For example, a PROPFIND request from a WebDAV scanner. The error handler middleware translates this into a 400 Bad Request response.

Constructors

BadHttpMethodException
Fields method :: ByteString

Instances

Instances details

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