Safe Haskell	None
Language	Haskell2010

Web.Growler.Types

Documentation

data MatchResult Source

Constructors

Fail
Partial [Param]
Complete [Param]

Instances

Eq MatchResult
Show MatchResult
Monoid MatchResult

newtype RoutePattern Source

Constructors

RoutePattern
Fields runRoutePattern :: Request -> RoutePatternResult

Instances

IsString RoutePattern
Monoid RoutePattern

data RoutePatternResult Source

Constructors

RoutePatternResult
Fields routePatternResultName :: !Text routePatternResultRequest :: !Request The (potentially) updated request after consuming a portion of the path routePatternResultMatchResult :: !MatchResult

path :: Request -> Text Source

capture :: Text -> RoutePattern Source

type Param = (ByteString, ByteString) Source

data BodySource Source

Constructors

FileSource !FilePath !(Maybe FilePart)
BuilderSource !Builder
LBSSource !ByteString
StreamSource !StreamingBody
RawSource !(IO ByteString -> (ByteString -> IO ()) -> IO ()) !Response

Instances

HasBodySource ResponseState BodySource

data RequestState Source

Constructors

RequestState
Fields requestStateMatchedPattern :: Maybe Text requestStateParams :: [Param] requestStateRequest :: Request

Instances

HasRequest RequestState Request
HasParams RequestState [Param]
HasMatchedPattern RequestState (Maybe Text)

data ResponseState Source

Constructors

ResponseState
Fields responseStateStatus :: !Status responseStateHeaders :: !(HashMap (CI ByteString) [ByteString]) responseStateBodySource :: !BodySource

Instances

HasStatus ResponseState Status
HasBodySource ResponseState BodySource
HasHeaders ResponseState (HashMap (CI ByteString) [ByteString])

class HasBodySource s a | s -> a where Source

Methods

bodySource :: Lens' s a Source

Instances

HasBodySource ResponseState BodySource

class HasHeaders s a | s -> a where Source

Methods

headers :: Lens' s a Source

Instances

HasHeaders ResponseState (HashMap (CI ByteString) [ByteString])

class HasStatus s a | s -> a where Source

Methods

status :: Lens' s a Source

Instances

HasStatus ResponseState Status

class HasMatchedPattern s a | s -> a where Source

Methods

matchedPattern :: Lens' s a Source

Instances

HasMatchedPattern RequestState (Maybe Text)

class HasParams s a | s -> a where Source

Methods

params :: Lens' s a Source

Instances

HasParams RequestState [Param]

class HasRequest s a | s -> a where Source

Methods

request :: Lens' s a Source

Instances

HasRequest RequestState Request

type EarlyTermination = ResponseState Source

type HandlerAbort m = EitherT EarlyTermination m Source

newtype HandlerT m a Source

Constructors

HandlerT
Fields fromHandler :: RWST RequestState () ResponseState (HandlerAbort m) a

Instances

MonadTrans HandlerT
MonadTransControl HandlerT
MonadBase b m => MonadBase b (HandlerT m)
MonadBaseControl b m => MonadBaseControl b (HandlerT m)
Monad m => Monad (HandlerT m)
Monad m => Functor (HandlerT m)
Monad m => Applicative (HandlerT m)
MonadIO m => MonadIO (HandlerT m)
type StT HandlerT a = StHandlerT a
type StM (HandlerT m) a = ComposeSt HandlerT m a

newtype StHandlerT a Source

Constructors

StHandlerT
Fields unStHandlerT :: Either ResponseState (a, ResponseState)

type Handler = HandlerT IO Source

newtype GrowlerT m a Source

Constructors

GrowlerT
Fields fromGrowlerT :: StateT [(StdMethod, RoutePattern, HandlerT m ())] m a

Instances

Monad m => Monad (GrowlerT m)
Functor m => Functor (GrowlerT m)
(Functor m, Monad m) => Applicative (GrowlerT m)
MonadIO m => MonadIO (GrowlerT m)

type Growler = GrowlerT IO Source

data JsonInputError Source

Constructors

RequestBodyExhausted
JsonError DecodingError

Instances

Eq JsonInputError
Show JsonInputError

data GrowlerConfig m Source

Constructors

GrowlerConfig
Fields growlerConfigNotFoundHandler :: HandlerT m () The 404 not found handler. If no route matches, then this handler will be evaluated. growlerConfigErrorHandler :: SomeException -> HandlerT m () The uncaught exception handler. If an exception is thrown and not caught while trying to service a request, then this handler will be evaluated.