Safe Haskell	None
Language	Haskell2010

Symantic.HTTP.Server

Contents

Type Server
Type ServerRes
Type ServerResStream
Type Router
- Type Captures
  - Type BinTree
  - Type family AltFromBinTree
- Class HTTP_Routing
Orphan instances

Description

See symantic-http-demo for an example of how to use this module.

Synopsis

newtype Server handlers k = Server {
- unServer :: StateT ServerState (ServerCheckT [ServerErrorBody] (ServerCheckT [ServerErrorHeader] (ServerCheckT [ServerErrorQuery] (ServerCheckT [ServerErrorContentType] (ServerCheckT [ServerErrorAccept] (ServerCheckT [ServerErrorBasicAuth] (ServerCheckT [ServerErrorMethod] (ServerCheckT [ServerErrorPath] IO)))))))) (handlers -> k)
}
server :: Router Server handlers (Response Server) -> handlers -> Application
runServerChecks :: StateT ServerState (ExceptT e1 (ExceptT e2 (ExceptT e3 (ExceptT e4 (ExceptT e5 (ExceptT e6 (ExceptT e7 (ExceptT e8 IO)))))))) a -> ServerState -> IO (Either e8 (Either e7 (Either e6 (Either e5 (Either e4 (Either e3 (Either e2 (Either e1 (a, ServerState)))))))))
type ServerCheckT e = ExceptT (Fail e)
type RouteResult e = Either (Fail e)
data Fail e
- = Fail ServerState e
- | FailFatal !ServerState !e
failState :: Fail e -> ServerState
failError :: Fail e -> e
newtype ServerState = ServerState {
- serverState_request :: Request
}
newtype ServerErrorPath = ServerErrorPath Text
data ServerErrorMethod = ServerErrorMethod
data ServerErrorAccept = ServerErrorAccept MediaTypes (Maybe (Either ByteString MediaType))
data ServerErrorContentType = ServerErrorContentType
newtype ServerErrorQuery = ServerErrorQuery Text
data ServerErrorHeader = ServerErrorHeader
data ServerErrorBasicAuth = ServerErrorBasicAuth BasicAuthRealm (BasicAuth ())
class ServerBasicAuth a where
- serverBasicAuth :: BasicAuthUser -> BasicAuthPass -> IO (BasicAuth a)
newtype ServerErrorBody = ServerErrorBody String
newtype ServerBodyArg (ts :: [Type]) a = ServerBodyArg a
newtype ServerBodyStreamArg as (ts :: [Type]) framing = ServerBodyStreamArg as
newtype ServerRes (ts :: [Type]) m a = ServerResponse {
- unServerResponse :: m a
}
type ServerResponse ts m = ServerRes ts (ReaderT Request (WriterT ResponseHeaders (WriterT Status (ContT Response m))))
newtype ServerResStream framing (ts :: [Type]) m as = ServerResponseStream {
- unServerResponseStream :: m as
}
type ServerResponseStream framing ts m = ServerResStream framing ts (ReaderT Request (WriterT ResponseHeaders (WriterT Status (ContT Response m))))
data Router repr a b where
- Router_Any :: repr a b -> Router repr a b
- Router_Seg :: PathSegment -> Router repr k k
- Router_Cat :: Router repr a b -> Router repr b c -> Router repr a c
- Router_Map :: Map PathSegment (Router repr a k) -> Router repr a k
- Router_Alt :: Router repr a k -> Router repr b k -> Router repr (a :!: b) k
- Router_Cap :: PathConstraint Server a => Name -> Router repr (a -> k) k
- Router_Caps :: Captures (Router repr) cs k -> Router repr (AltFromBinTree cs) k
- Router_Union :: (b -> a) -> Router repr a k -> Router repr b k
data Captures repr (cs :: BinTree Type) k where
- Captures0 :: PathConstraint Server a => Proxy a -> Name -> repr x k -> Captures repr (BinTree0 (a -> x)) k
- Captures2 :: Captures repr x k -> Captures repr y k -> Captures repr (BinTree2 x y) k
data BinTree a
- = BinTree0 a
- | BinTree2 (BinTree a) (BinTree a)
type family AltFromBinTree (cs :: BinTree Type) :: Type where ...
class HTTP_Routing repr where
- routing :: Map PathSegment (repr a k) -> repr a k
- captures :: Captures repr cs k -> repr (AltFromBinTree cs) k
router :: Router repr a b -> Router repr a b
router_Alt :: Router repr a k -> Router repr b k -> Router repr (a :!: b) k
router_Map :: Map PathSegment (Router repr a k) -> Map PathSegment (Router repr b k) -> Router repr (a :!: b) k

Type `Server`

newtype Server handlers k Source #

(Server handlers k) is a recipe to produce an Application from given (handlers) (one per number of alternative routes), separated by (:!:).

Server is analogous to a scanf using the API as a format customized for HTTP routing.

The multiple ServerCheckT monad transformers are there to prioritize the errors according to the type of check raising them, instead of the order of the combinators within an actual API specification.

Constructors

Server
Fields unServer :: StateT ServerState (ServerCheckT [ServerErrorBody] (ServerCheckT [ServerErrorHeader] (ServerCheckT [ServerErrorQuery] (ServerCheckT [ServerErrorContentType] (ServerCheckT [ServerErrorAccept] (ServerCheckT [ServerErrorBasicAuth] (ServerCheckT [ServerErrorMethod] (ServerCheckT [ServerErrorPath] IO)))))))) (handlers -> k)

Instances

Cat Server Source #
Instance details Defined in Symantic.HTTP.Server Methods (<.>) :: Server a b -> Server b c -> Server a c #
Alt Server Source #
Instance details Defined in Symantic.HTTP.Server Methods (<!>) :: Server a k -> Server b k -> Server (a :!: b) k #
Pro Server Source #
Instance details Defined in Symantic.HTTP.Server Methods dimap :: (a -> b) -> (b -> a) -> Server (a -> k) k -> Server (b -> k) k #
HTTP_Raw Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type RawConstraint Server :: Constraint # type RawArgs Server :: Type # type Raw Server :: Type # Methods raw :: Server (RawArgs Server) (Raw Server) #
HTTP_Path Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type PathConstraint Server a :: Constraint # Methods segment :: PathSegment -> Server k k # capture' :: PathConstraint Server a => Name -> Server (a -> k) k # captureAll :: Server ([PathSegment] -> k) k #
HTTP_Header Server Source #
Instance details Defined in Symantic.HTTP.Server Methods header :: HeaderName -> Server (HeaderValue -> k) k #
HTTP_Body Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyArg Server a ts :: Type # type BodyConstraint Server a ts :: Constraint # Methods body' :: BodyConstraint Server a ts => Server (BodyArg Server a ts -> k) k #
HTTP_BodyStream Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyStreamArg Server as ts framing :: Type # type BodyStreamConstraint Server as ts framing :: Constraint # Methods bodyStream' :: BodyStreamConstraint Server as ts framing => Server (BodyStreamArg Server as ts framing -> k) k #
HTTP_Query Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type QueryConstraint Server a :: Constraint # Methods queryParams' :: QueryConstraint Server a => QueryName -> Server ([a] -> k) k # queryFlag :: QueryConstraint Server Bool => QueryName -> Server (Bool -> k) k #
HTTP_BasicAuth Server Source #	WARNING: current implementation of Basic Access Authentication is not immune to certain kinds of timing attacks. Decoding payloads does not take a fixed amount of time.
Instance details Defined in Symantic.HTTP.Server Associated Types type BasicAuthConstraint Server a :: Constraint # type BasicAuthArgs Server a k :: Type # Methods basicAuth' :: BasicAuthConstraint Server a => BasicAuthRealm -> Server (BasicAuthArgs Server a k) k #
HTTP_Version Server Source #	TODO: add its own error?
Instance details Defined in Symantic.HTTP.Server Methods version :: HttpVersion -> Server k k #
HTTP_Response Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseConstraint Server a ts :: Constraint # type ResponseArgs Server a ts :: Type # type Response Server :: Type # Methods response :: ResponseConstraint Server a ts => Method -> Server (ResponseArgs Server a ts) (Response Server) #
HTTP_ResponseStream Server Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseStreamConstraint Server as ts framing :: Constraint # type ResponseStreamArgs Server as ts framing :: Type # type ResponseStream Server :: Type # Methods responseStream :: ResponseStreamConstraint Server as ts framing => Method -> Server (ResponseStreamArgs Server as ts framing) (ResponseStream Server) #
HTTP_Routing Server Source #
Instance details Defined in Symantic.HTTP.Server Methods routing :: Map PathSegment (Server a k) -> Server a k Source # captures :: Captures Server cs k -> Server (AltFromBinTree cs) k Source #
Cat (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods (<.>) :: Router Server a b -> Router Server b c -> Router Server a c #
Alt (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods (<!>) :: Router Server a k -> Router Server b k -> Router Server (a :!: b) k #
Trans (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type UnTrans (Router Server) :: Type -> Type -> Type # Methods noTrans :: UnTrans (Router Server) a b -> Router Server a b # unTrans :: Router Server a b -> UnTrans (Router Server) a b #
Pro (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods dimap :: (a -> b) -> (b -> a) -> Router Server (a -> k) k -> Router Server (b -> k) k #
HTTP_Raw (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type RawConstraint (Router Server) :: Constraint # type RawArgs (Router Server) :: Type # type Raw (Router Server) :: Type # Methods raw :: Router Server (RawArgs (Router Server)) (Raw (Router Server)) #
HTTP_Header (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods header :: HeaderName -> Router Server (HeaderValue -> k) k #
HTTP_Body (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyArg (Router Server) a ts :: Type # type BodyConstraint (Router Server) a ts :: Constraint # Methods body' :: BodyConstraint (Router Server) a ts => Router Server (BodyArg (Router Server) a ts -> k) k #
HTTP_BodyStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyStreamArg (Router Server) as ts framing :: Type # type BodyStreamConstraint (Router Server) as ts framing :: Constraint # Methods bodyStream' :: BodyStreamConstraint (Router Server) as ts framing => Router Server (BodyStreamArg (Router Server) as ts framing -> k) k #
HTTP_Query (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type QueryConstraint (Router Server) a :: Constraint # Methods queryParams' :: QueryConstraint (Router Server) a => QueryName -> Router Server ([a] -> k) k # queryFlag :: QueryConstraint (Router Server) Bool => QueryName -> Router Server (Bool -> k) k #
HTTP_BasicAuth (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BasicAuthConstraint (Router Server) a :: Constraint # type BasicAuthArgs (Router Server) a k :: Type # Methods basicAuth' :: BasicAuthConstraint (Router Server) a => BasicAuthRealm -> Router Server (BasicAuthArgs (Router Server) a k) k #
HTTP_Response (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseConstraint (Router Server) a ts :: Constraint # type ResponseArgs (Router Server) a ts :: Type # type Response (Router Server) :: Type # Methods response :: ResponseConstraint (Router Server) a ts => Method -> Router Server (ResponseArgs (Router Server) a ts) (Response (Router Server)) #
HTTP_ResponseStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseStreamConstraint (Router Server) as ts framing :: Constraint # type ResponseStreamArgs (Router Server) as ts framing :: Type # type ResponseStream (Router Server) :: Type # Methods responseStream :: ResponseStreamConstraint (Router Server) as ts framing => Method -> Router Server (ResponseStreamArgs (Router Server) as ts framing) (ResponseStream (Router Server)) #
HTTP_Routing (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods routing :: Map PathSegment (Router Server a k) -> Router Server a k Source # captures :: Captures (Router Server) cs k -> Router Server (AltFromBinTree cs) k Source #
type Raw Server Source #
Instance details Defined in Symantic.HTTP.Server type Raw Server = Application
type RawArgs Server Source #
Instance details Defined in Symantic.HTTP.Server type RawArgs Server = Application
type RawConstraint Server Source #
Instance details Defined in Symantic.HTTP.Server type RawConstraint Server = ()
type Response Server Source #
Instance details Defined in Symantic.HTTP.Server type Response Server = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
type ResponseStream Server Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStream Server = Application
type PathConstraint Server a Source #
Instance details Defined in Symantic.HTTP.Server type PathConstraint Server a = FromHttpApiData a
type QueryConstraint Server a Source #
Instance details Defined in Symantic.HTTP.Server type QueryConstraint Server a = FromHttpApiData a
type BasicAuthConstraint Server a Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthConstraint Server a = ServerBasicAuth a
type BodyConstraint Server a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyConstraint Server a ts = MimeTypes ts (MimeDecodable a)
type BodyArg Server a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyArg Server a ts = ServerBodyArg ts a
type BasicAuthArgs Server a k Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthArgs Server a k = a -> k
type ResponseArgs Server a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseArgs Server a ts = ServerResponse ts IO a
type ResponseConstraint Server a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseConstraint Server a ts = MimeTypes ts (MimeEncodable a)
type BodyStreamConstraint Server as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamConstraint Server as ts framing = (FramingDecode framing as, MonadExec IO (FramingMonad as), MimeTypes ts (MimeDecodable (FramingYield as)))
type BodyStreamArg Server as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamArg Server as ts framing = ServerBodyStreamArg as ts framing
type ResponseStreamArgs Server as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamArgs Server as ts framing = ServerResponseStream framing ts IO as
type ResponseStreamConstraint Server as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamConstraint Server as ts framing = (FramingEncode framing as, MimeTypes ts (MimeEncodable (FramingYield as)))
type UnTrans (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type UnTrans (Router Server) = Server
type Raw (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type Raw (Router Server) = Raw (UnTrans (Router Server))
type RawArgs (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type RawArgs (Router Server) = RawArgs (UnTrans (Router Server))
type RawConstraint (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type RawConstraint (Router Server) = RawConstraint (UnTrans (Router Server))
type Response (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type Response (Router Server) = Response (UnTrans (Router Server))
type ResponseStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStream (Router Server) = ResponseStream (UnTrans (Router Server))
type QueryConstraint (Router Server) a Source #
Instance details Defined in Symantic.HTTP.Server type QueryConstraint (Router Server) a = QueryConstraint (UnTrans (Router Server)) a
type BasicAuthConstraint (Router Server) a Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthConstraint (Router Server) a = BasicAuthConstraint (UnTrans (Router Server)) a
type BodyConstraint (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyConstraint (Router Server) a ts = BodyConstraint (UnTrans (Router Server)) a ts
type BodyArg (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyArg (Router Server) a ts = BodyArg (UnTrans (Router Server)) a ts
type BasicAuthArgs (Router Server) a k Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthArgs (Router Server) a k = BasicAuthArgs (UnTrans (Router Server)) a k
type ResponseArgs (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseArgs (Router Server) a ts = ResponseArgs (UnTrans (Router Server)) a ts
type ResponseConstraint (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseConstraint (Router Server) a ts = ResponseConstraint (UnTrans (Router Server)) a ts
type BodyStreamConstraint (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamConstraint (Router Server) as ts framing = BodyStreamConstraint (UnTrans (Router Server)) as ts framing
type BodyStreamArg (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamArg (Router Server) as ts framing = BodyStreamArg (UnTrans (Router Server)) as ts framing
type ResponseStreamArgs (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamArgs (Router Server) as ts framing = ResponseStreamArgs (UnTrans (Router Server)) as ts framing
type ResponseStreamConstraint (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamConstraint (Router Server) as ts framing = ResponseStreamConstraint (UnTrans (Router Server)) as ts framing

server :: Router Server handlers (Response Server) -> handlers -> Application Source #

(server api handlers) returns an Application ready to be given to Warp.run 80.

runServerChecks :: StateT ServerState (ExceptT e1 (ExceptT e2 (ExceptT e3 (ExceptT e4 (ExceptT e5 (ExceptT e6 (ExceptT e7 (ExceptT e8 IO)))))))) a -> ServerState -> IO (Either e8 (Either e7 (Either e6 (Either e5 (Either e4 (Either e3 (Either e2 (Either e1 (a, ServerState))))))))) Source #

Unwrap the ExceptT constructors to reach the Either constructors.

Type `ServerCheckT`

type ServerCheckT e = ExceptT (Fail e) Source #

Type `RouteResult`

type RouteResult e = Either (Fail e) Source #

Type `Fail`

data Fail e Source #

Constructors

Fail ServerState e	Keep trying other paths. 404, 405 or 406.
FailFatal !ServerState !e	Don't try other paths.

Instances

Show e => Show (Fail e) Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> Fail e -> ShowS # show :: Fail e -> String # showList :: [Fail e] -> ShowS #
Semigroup e => Semigroup (Fail e) Source #
Instance details Defined in Symantic.HTTP.Server Methods (<>) :: Fail e -> Fail e -> Fail e # sconcat :: NonEmpty (Fail e) -> Fail e # stimes :: Integral b => b -> Fail e -> Fail e #

failState :: Fail e -> ServerState Source #

failError :: Fail e -> e Source #

Type `ServerState`

newtype ServerState Source #

Constructors

ServerState
Fields serverState_request :: Request

Instances

Show ServerState Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerState -> ShowS # show :: ServerState -> String # showList :: [ServerState] -> ShowS #

Type `ServerErrorPath`

newtype ServerErrorPath Source #

Constructors

ServerErrorPath Text

Instances

Eq ServerErrorPath Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorPath -> ServerErrorPath -> Bool # (/=) :: ServerErrorPath -> ServerErrorPath -> Bool #
Show ServerErrorPath Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorPath -> ShowS # show :: ServerErrorPath -> String # showList :: [ServerErrorPath] -> ShowS #

Type `ServerErrorMethod`

data ServerErrorMethod Source #

Constructors

ServerErrorMethod

Instances

Eq ServerErrorMethod Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorMethod -> ServerErrorMethod -> Bool # (/=) :: ServerErrorMethod -> ServerErrorMethod -> Bool #
Show ServerErrorMethod Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorMethod -> ShowS # show :: ServerErrorMethod -> String # showList :: [ServerErrorMethod] -> ShowS #

Type `ServerErrorAccept`

data ServerErrorAccept Source #

Constructors

ServerErrorAccept MediaTypes (Maybe (Either ByteString MediaType))

Instances

Eq ServerErrorAccept Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorAccept -> ServerErrorAccept -> Bool # (/=) :: ServerErrorAccept -> ServerErrorAccept -> Bool #
Show ServerErrorAccept Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorAccept -> ShowS # show :: ServerErrorAccept -> String # showList :: [ServerErrorAccept] -> ShowS #

Type `ServerErrorContentType`

data ServerErrorContentType Source #

Constructors

ServerErrorContentType

Instances

Eq ServerErrorContentType Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorContentType -> ServerErrorContentType -> Bool # (/=) :: ServerErrorContentType -> ServerErrorContentType -> Bool #
Show ServerErrorContentType Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorContentType -> ShowS # show :: ServerErrorContentType -> String # showList :: [ServerErrorContentType] -> ShowS #

Type `ServerErrorQuery`

newtype ServerErrorQuery Source #

Constructors

ServerErrorQuery Text

Instances

Show ServerErrorQuery Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorQuery -> ShowS # show :: ServerErrorQuery -> String # showList :: [ServerErrorQuery] -> ShowS #

Type `ServerErrorHeader`

data ServerErrorHeader Source #

Constructors

ServerErrorHeader

Instances

Eq ServerErrorHeader Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorHeader -> ServerErrorHeader -> Bool # (/=) :: ServerErrorHeader -> ServerErrorHeader -> Bool #
Show ServerErrorHeader Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorHeader -> ShowS # show :: ServerErrorHeader -> String # showList :: [ServerErrorHeader] -> ShowS #

Type `ServerErrorBasicAuth`

data ServerErrorBasicAuth Source #

Constructors

ServerErrorBasicAuth BasicAuthRealm (BasicAuth ())

Instances

Show ServerErrorBasicAuth Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorBasicAuth -> ShowS # show :: ServerErrorBasicAuth -> String # showList :: [ServerErrorBasicAuth] -> ShowS #

Class `ServerBasicAuth`

class ServerBasicAuth a where Source #

Custom BasicAuth check.

Methods

serverBasicAuth :: BasicAuthUser -> BasicAuthPass -> IO (BasicAuth a) Source #

Type `ServerErrorBody`

newtype ServerErrorBody Source #

Constructors

ServerErrorBody String

Instances

Eq ServerErrorBody Source #
Instance details Defined in Symantic.HTTP.Server Methods (==) :: ServerErrorBody -> ServerErrorBody -> Bool # (/=) :: ServerErrorBody -> ServerErrorBody -> Bool #
Show ServerErrorBody Source #
Instance details Defined in Symantic.HTTP.Server Methods showsPrec :: Int -> ServerErrorBody -> ShowS # show :: ServerErrorBody -> String # showList :: [ServerErrorBody] -> ShowS #

Type `ServerBodyArg`

newtype ServerBodyArg (ts :: [Type]) a Source #

Constructors

ServerBodyArg a

Type `ServerBodyStreamArg`

newtype ServerBodyStreamArg as (ts :: [Type]) framing Source #

Constructors

ServerBodyStreamArg as

Type `ServerRes`

newtype ServerRes (ts :: [Type]) m a Source #

A continuation for server's users to respond.

This newtype has two uses :

Carrying the ts type variable to server.
Providing a return for the simple response case of status200 and no extra headers.

Constructors

ServerResponse
Fields unServerResponse :: m a

Instances

MonadTrans (ServerRes ts) Source #
Instance details Defined in Symantic.HTTP.Server Methods lift :: Monad m => m a -> ServerRes ts m a #
Monad m => Monad (ServerRes ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods (>>=) :: ServerRes ts m a -> (a -> ServerRes ts m b) -> ServerRes ts m b # (>>) :: ServerRes ts m a -> ServerRes ts m b -> ServerRes ts m b # return :: a -> ServerRes ts m a # fail :: String -> ServerRes ts m a #
Functor m => Functor (ServerRes ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods fmap :: (a -> b) -> ServerRes ts m a -> ServerRes ts m b # (<$) :: a -> ServerRes ts m b -> ServerRes ts m a #
Applicative m => Applicative (ServerRes ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods pure :: a -> ServerRes ts m a # (<>) :: ServerRes ts m (a -> b) -> ServerRes ts m a -> ServerRes ts m b # liftA2 :: (a -> b -> c) -> ServerRes ts m a -> ServerRes ts m b -> ServerRes ts m c # (>) :: ServerRes ts m a -> ServerRes ts m b -> ServerRes ts m b # (<*) :: ServerRes ts m a -> ServerRes ts m b -> ServerRes ts m a #
type CanDo (ServerResponse ts m) (eff :: Type) Source #	All supported effects are handled by nested `Monad`s.
Instance details Defined in Symantic.HTTP.Server type CanDo (ServerResponse ts m) (eff :: Type) = False

type ServerResponse ts m = ServerRes ts (ReaderT Request (WriterT ResponseHeaders (WriterT Status (ContT Response m)))) Source #

Type `ServerResStream`

newtype ServerResStream framing (ts :: [Type]) m as Source #

Constructors

ServerResponseStream
Fields unServerResponseStream :: m as

Instances

MonadTrans (ServerResStream framing ts) Source #
Instance details Defined in Symantic.HTTP.Server Methods lift :: Monad m => m a -> ServerResStream framing ts m a #
Monad m => Monad (ServerResStream framing ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods (>>=) :: ServerResStream framing ts m a -> (a -> ServerResStream framing ts m b) -> ServerResStream framing ts m b # (>>) :: ServerResStream framing ts m a -> ServerResStream framing ts m b -> ServerResStream framing ts m b # return :: a -> ServerResStream framing ts m a # fail :: String -> ServerResStream framing ts m a #
Functor m => Functor (ServerResStream framing ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods fmap :: (a -> b) -> ServerResStream framing ts m a -> ServerResStream framing ts m b # (<$) :: a -> ServerResStream framing ts m b -> ServerResStream framing ts m a #
Applicative m => Applicative (ServerResStream framing ts m) Source #
Instance details Defined in Symantic.HTTP.Server Methods pure :: a -> ServerResStream framing ts m a # (<>) :: ServerResStream framing ts m (a -> b) -> ServerResStream framing ts m a -> ServerResStream framing ts m b # liftA2 :: (a -> b -> c) -> ServerResStream framing ts m a -> ServerResStream framing ts m b -> ServerResStream framing ts m c # (>) :: ServerResStream framing ts m a -> ServerResStream framing ts m b -> ServerResStream framing ts m b # (<*) :: ServerResStream framing ts m a -> ServerResStream framing ts m b -> ServerResStream framing ts m a #
type CanDo (ServerResponseStream framing ts m) (eff :: Type) Source #	All supported effects are handled by nested `Monad`s.
Instance details Defined in Symantic.HTTP.Server type CanDo (ServerResponseStream framing ts m) (eff :: Type) = False

type ServerResponseStream framing ts m = ServerResStream framing ts (ReaderT Request (WriterT ResponseHeaders (WriterT Status (ContT Response m)))) Source #

Type `Router`

data Router repr a b where Source #

Transform a Server to merge Alternative segments into a routing.

Constructors

Router_Any :: repr a b -> Router repr a b	Lift any `(repr)` into `Router`, those not useful to segregate wrt. the `Trans`formation performed, aka. `noTrans`.
Router_Seg :: PathSegment -> Router repr k k	Represent `segment`.
Router_Cat :: Router repr a b -> Router repr b c -> Router repr a c	Represent (`<.>`).
Router_Map :: Map PathSegment (Router repr a k) -> Router repr a k	Represent `routing`.
Router_Alt :: Router repr a k -> Router repr b k -> Router repr (a :!: b) k	Represent (`<!>`).
Router_Cap :: PathConstraint Server a => Name -> Router repr (a -> k) k	Represent `capture'`.
Router_Caps :: Captures (Router repr) cs k -> Router repr (AltFromBinTree cs) k	Represent `captures`.
Router_Union :: (b -> a) -> Router repr a k -> Router repr b k	Unify `Router`s which have different `handlers`. Useful to put alternative `Router`s in a `Map` as in `Router_Map`.

Instances

Cat (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods (<.>) :: Router Server a b -> Router Server b c -> Router Server a c #
Alt (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods (<!>) :: Router Server a k -> Router Server b k -> Router Server (a :!: b) k #
Trans (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type UnTrans (Router Server) :: Type -> Type -> Type # Methods noTrans :: UnTrans (Router Server) a b -> Router Server a b # unTrans :: Router Server a b -> UnTrans (Router Server) a b #
Pro (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods dimap :: (a -> b) -> (b -> a) -> Router Server (a -> k) k -> Router Server (b -> k) k #
HTTP_Raw (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type RawConstraint (Router Server) :: Constraint # type RawArgs (Router Server) :: Type # type Raw (Router Server) :: Type # Methods raw :: Router Server (RawArgs (Router Server)) (Raw (Router Server)) #
repr ~ Server => HTTP_Path (Router repr) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type PathConstraint (Router repr) a :: Constraint # Methods segment :: PathSegment -> Router repr k k # capture' :: PathConstraint (Router repr) a => Name -> Router repr (a -> k) k # captureAll :: Router repr ([PathSegment] -> k) k #
HTTP_Header (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods header :: HeaderName -> Router Server (HeaderValue -> k) k #
HTTP_Body (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyArg (Router Server) a ts :: Type # type BodyConstraint (Router Server) a ts :: Constraint # Methods body' :: BodyConstraint (Router Server) a ts => Router Server (BodyArg (Router Server) a ts -> k) k #
HTTP_BodyStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BodyStreamArg (Router Server) as ts framing :: Type # type BodyStreamConstraint (Router Server) as ts framing :: Constraint # Methods bodyStream' :: BodyStreamConstraint (Router Server) as ts framing => Router Server (BodyStreamArg (Router Server) as ts framing -> k) k #
HTTP_Query (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type QueryConstraint (Router Server) a :: Constraint # Methods queryParams' :: QueryConstraint (Router Server) a => QueryName -> Router Server ([a] -> k) k # queryFlag :: QueryConstraint (Router Server) Bool => QueryName -> Router Server (Bool -> k) k #
HTTP_BasicAuth (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type BasicAuthConstraint (Router Server) a :: Constraint # type BasicAuthArgs (Router Server) a k :: Type # Methods basicAuth' :: BasicAuthConstraint (Router Server) a => BasicAuthRealm -> Router Server (BasicAuthArgs (Router Server) a k) k #
HTTP_Response (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseConstraint (Router Server) a ts :: Constraint # type ResponseArgs (Router Server) a ts :: Type # type Response (Router Server) :: Type # Methods response :: ResponseConstraint (Router Server) a ts => Method -> Router Server (ResponseArgs (Router Server) a ts) (Response (Router Server)) #
HTTP_ResponseStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Associated Types type ResponseStreamConstraint (Router Server) as ts framing :: Constraint # type ResponseStreamArgs (Router Server) as ts framing :: Type # type ResponseStream (Router Server) :: Type # Methods responseStream :: ResponseStreamConstraint (Router Server) as ts framing => Method -> Router Server (ResponseStreamArgs (Router Server) as ts framing) (ResponseStream (Router Server)) #
HTTP_Routing (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods routing :: Map PathSegment (Router Server a k) -> Router Server a k Source # captures :: Captures (Router Server) cs k -> Router Server (AltFromBinTree cs) k Source #
type UnTrans (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type UnTrans (Router Server) = Server
type Raw (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type Raw (Router Server) = Raw (UnTrans (Router Server))
type RawArgs (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type RawArgs (Router Server) = RawArgs (UnTrans (Router Server))
type RawConstraint (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type RawConstraint (Router Server) = RawConstraint (UnTrans (Router Server))
type Response (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type Response (Router Server) = Response (UnTrans (Router Server))
type ResponseStream (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStream (Router Server) = ResponseStream (UnTrans (Router Server))
type PathConstraint (Router repr) a Source #
Instance details Defined in Symantic.HTTP.Server type PathConstraint (Router repr) a = PathConstraint repr a
type QueryConstraint (Router Server) a Source #
Instance details Defined in Symantic.HTTP.Server type QueryConstraint (Router Server) a = QueryConstraint (UnTrans (Router Server)) a
type BasicAuthConstraint (Router Server) a Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthConstraint (Router Server) a = BasicAuthConstraint (UnTrans (Router Server)) a
type BodyConstraint (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyConstraint (Router Server) a ts = BodyConstraint (UnTrans (Router Server)) a ts
type BodyArg (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type BodyArg (Router Server) a ts = BodyArg (UnTrans (Router Server)) a ts
type BasicAuthArgs (Router Server) a k Source #
Instance details Defined in Symantic.HTTP.Server type BasicAuthArgs (Router Server) a k = BasicAuthArgs (UnTrans (Router Server)) a k
type ResponseArgs (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseArgs (Router Server) a ts = ResponseArgs (UnTrans (Router Server)) a ts
type ResponseConstraint (Router Server) a ts Source #
Instance details Defined in Symantic.HTTP.Server type ResponseConstraint (Router Server) a ts = ResponseConstraint (UnTrans (Router Server)) a ts
type BodyStreamConstraint (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamConstraint (Router Server) as ts framing = BodyStreamConstraint (UnTrans (Router Server)) as ts framing
type BodyStreamArg (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type BodyStreamArg (Router Server) as ts framing = BodyStreamArg (UnTrans (Router Server)) as ts framing
type ResponseStreamArgs (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamArgs (Router Server) as ts framing = ResponseStreamArgs (UnTrans (Router Server)) as ts framing
type ResponseStreamConstraint (Router Server) as ts framing Source #
Instance details Defined in Symantic.HTTP.Server type ResponseStreamConstraint (Router Server) as ts framing = ResponseStreamConstraint (UnTrans (Router Server)) as ts framing

Type `Captures`

data Captures repr (cs :: BinTree Type) k where Source #

Constructors

Captures0 :: PathConstraint Server a => Proxy a -> Name -> repr x k -> Captures repr (BinTree0 (a -> x)) k
Captures2 :: Captures repr x k -> Captures repr y k -> Captures repr (BinTree2 x y) k

Type `BinTree`

data BinTree a Source #

Use DataKinds to define a BinTree of Types. Useful for gathering together captures of different Types.

Constructors

BinTree0 a
BinTree2 (BinTree a) (BinTree a)

Type family `AltFromBinTree`

type family AltFromBinTree (cs :: BinTree Type) :: Type where ... Source #

Equations

AltFromBinTree (BinTree0 x) = x
AltFromBinTree (BinTree2 x y) = AltFromBinTree x :!: AltFromBinTree y

Class `HTTP_Routing`

class HTTP_Routing repr where Source #

Minimal complete definition

Nothing

Methods

routing :: Map PathSegment (repr a k) -> repr a k Source #

captures :: Captures repr cs k -> repr (AltFromBinTree cs) k Source #

routing :: Trans repr => HTTP_Routing (UnTrans repr) => Map PathSegment (repr a k) -> repr a k Source #

captures :: Trans repr => HTTP_Routing (UnTrans repr) => Captures repr cs k -> repr (AltFromBinTree cs) k Source #

Instances

HTTP_Routing Server Source #
Instance details Defined in Symantic.HTTP.Server Methods routing :: Map PathSegment (Server a k) -> Server a k Source # captures :: Captures Server cs k -> Server (AltFromBinTree cs) k Source #
HTTP_Routing (Router Server) Source #
Instance details Defined in Symantic.HTTP.Server Methods routing :: Map PathSegment (Router Server a k) -> Router Server a k Source # captures :: Captures (Router Server) cs k -> Router Server (AltFromBinTree cs) k Source #

router :: Router repr a b -> Router repr a b Source #

Traverse a Router to transform it:

Associate Router_Cat to the right.
Replace Router_Seg with Router_Map.
Replace Router_Cap with Router_Caps.

Used in server on the Router inferred from the given API.

router_Alt :: Router repr a k -> Router repr b k -> Router repr (a :!: b) k Source #

Merge/reorder alternatives if possible or default to a Router_Alt.

router_Map :: Map PathSegment (Router repr a k) -> Map PathSegment (Router repr b k) -> Router repr (a :!: b) k Source #

Orphan instances

Semigroup Status Source #	Return worse `Status`.
Instance details Methods (<>) :: Status -> Status -> Status # sconcat :: NonEmpty Status -> Status # stimes :: Integral b => b -> Status -> Status #
Monoid Status Source #	Useful when `Status` is within a `WriterT`.
Instance details Methods mempty :: Status # mappend :: Status -> Status -> Status # mconcat :: [Status] -> Status #