Symantic.HTTP.Server

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

Type Server

newtype Server responses k

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

Server is analogous to a scanf using 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)))))))) (responses -> k)

Instances

Cat Server

Defined in Symantic.HTTP.Server

Methods

(<.>) :: Server a b -> Server b c -> Server a c

Alt Server

Defined in Symantic.HTTP.Server

Methods

(<!>) :: Server a k -> Server b k -> Server (a :!: b) k

Pro Server

Defined in Symantic.HTTP.Server

Methods

dimap :: (a -> b) -> (b -> a) -> Server (a -> k) k -> Server (b -> k) k

HTTP_Path Server

Defined in Symantic.HTTP.Server

Associated Types

type PathConstraint Server a :: Constraint

Methods

segment :: Segment -> Server k k

capture' :: PathConstraint Server a => Name -> Server (a -> k) k

captureAll :: Server ([Segment] -> k) k

HTTP_Header Server

Defined in Symantic.HTTP.Server

Methods

header :: HeaderName -> Server (HeaderValue -> k) k

HTTP_Body Server

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

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

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

WARNING: current implementation of Basic Access Authentication is not immune to certian kinds of timing attacks. Decoding payloads does not take a fixed amount of time.

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

TODO: add its own error?

Defined in Symantic.HTTP.Server

Methods

version :: HttpVersion -> Server k k

HTTP_Response Server

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

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)

Functor (Server responses)

Defined in Symantic.HTTP.Server

Methods

fmap :: (a -> b) -> Server responses a -> Server responses b

(<$) :: a -> Server responses b -> Server responses a

type Response Server

Defined in Symantic.HTTP.Server

type Response Server = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived

type ResponseStream Server

Defined in Symantic.HTTP.Server

type ResponseStream Server = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived

type PathConstraint Server a

Defined in Symantic.HTTP.Server

type PathConstraint Server a = FromHttpApiData a

type QueryConstraint Server a

Defined in Symantic.HTTP.Server

type QueryConstraint Server a = FromHttpApiData a

type BasicAuthConstraint Server a

Defined in Symantic.HTTP.Server

type BasicAuthConstraint Server a = ServerBasicAuth a

type BodyConstraint Server a ts

Defined in Symantic.HTTP.Server

type BodyConstraint Server a ts = MimeTypes ts (MimeDecodable a)

type BodyArg Server a ts

Defined in Symantic.HTTP.Server

type BodyArg Server a ts = ServerBodyArg ts a

type BasicAuthArgs Server a k

Defined in Symantic.HTTP.Server

type BasicAuthArgs Server a k = a -> k

type ResponseArgs Server a ts

Defined in Symantic.HTTP.Server

type ResponseArgs Server a ts = ServerResponse ts IO a

type ResponseConstraint Server a ts

Defined in Symantic.HTTP.Server

type ResponseConstraint Server a ts = MimeTypes ts (MimeEncodable a)

type BodyStreamConstraint Server as ts framing

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

Defined in Symantic.HTTP.Server

type BodyStreamArg Server as ts framing = ServerBodyStreamArg as ts framing

type ResponseStreamArgs Server as ts framing

Defined in Symantic.HTTP.Server

type ResponseStreamArgs Server as ts framing = ServerResponseStream framing ts IO as

type ResponseStreamConstraint Server as ts framing

Defined in Symantic.HTTP.Server

type ResponseStreamConstraint Server as ts framing = (FramingEncode framing as, MimeTypes ts (MimeEncodable (FramingYield as)))

server :: Server responses (Response Server) -> responses -> Application

server api responses returns a 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)))))))))

Unwrap the ExceptT constructors to reach the Either constructors.

Type ServerCheckT

type ServerCheckT e = ExceptT (Fail e)

Type RouteResult

type RouteResult e = Either (Fail e)

Type Fail

data Fail e

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)

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> Fail e -> ShowS

show :: Fail e -> String

showList :: [Fail e] -> ShowS

Semigroup e => Semigroup (Fail e)

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

failError :: Fail e -> e

Type ServerState

newtype ServerState

Constructors

ServerState

Fields

• serverState_request :: Request

Instances

Show ServerState

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerState -> ShowS

show :: ServerState -> String

showList :: [ServerState] -> ShowS

Type ServerErrorPath

newtype ServerErrorPath

Constructors

ServerErrorPath Text

Instances

Eq ServerErrorPath

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorPath -> ServerErrorPath -> Bool

(/=) :: ServerErrorPath -> ServerErrorPath -> Bool

Show ServerErrorPath

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorPath -> ShowS

show :: ServerErrorPath -> String

showList :: [ServerErrorPath] -> ShowS

Type ServerErrorMethod

data ServerErrorMethod

Constructors

ServerErrorMethod

Instances

Eq ServerErrorMethod

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorMethod -> ServerErrorMethod -> Bool

(/=) :: ServerErrorMethod -> ServerErrorMethod -> Bool

Show ServerErrorMethod

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorMethod -> ShowS

show :: ServerErrorMethod -> String

showList :: [ServerErrorMethod] -> ShowS

Type ServerErrorAccept

data ServerErrorAccept

Constructors

ServerErrorAccept MediaTypes (Maybe (Either ByteString MediaType))

Instances

Eq ServerErrorAccept

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorAccept -> ServerErrorAccept -> Bool

(/=) :: ServerErrorAccept -> ServerErrorAccept -> Bool

Show ServerErrorAccept

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorAccept -> ShowS

show :: ServerErrorAccept -> String

showList :: [ServerErrorAccept] -> ShowS

Type ServerErrorContentType

data ServerErrorContentType

Constructors

ServerErrorContentType

Instances

Eq ServerErrorContentType

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorContentType -> ServerErrorContentType -> Bool

(/=) :: ServerErrorContentType -> ServerErrorContentType -> Bool

Show ServerErrorContentType

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorContentType -> ShowS

show :: ServerErrorContentType -> String

showList :: [ServerErrorContentType] -> ShowS

Type ServerErrorQuery

newtype ServerErrorQuery

Constructors

ServerErrorQuery Text

Instances

Show ServerErrorQuery

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorQuery -> ShowS

show :: ServerErrorQuery -> String

showList :: [ServerErrorQuery] -> ShowS

Type ServerErrorHeader

data ServerErrorHeader

Constructors

ServerErrorHeader

Instances

Eq ServerErrorHeader

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorHeader -> ServerErrorHeader -> Bool

(/=) :: ServerErrorHeader -> ServerErrorHeader -> Bool

Show ServerErrorHeader

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorHeader -> ShowS

show :: ServerErrorHeader -> String

showList :: [ServerErrorHeader] -> ShowS

Type ServerErrorBasicAuth

data ServerErrorBasicAuth

Constructors

ServerErrorBasicAuth BasicAuthRealm (BasicAuth ())

Instances

Show ServerErrorBasicAuth

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorBasicAuth -> ShowS

show :: ServerErrorBasicAuth -> String

showList :: [ServerErrorBasicAuth] -> ShowS

Class ServerBasicAuth

class ServerBasicAuth a where

Methods

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

Type ServerErrorBody

newtype ServerErrorBody

Constructors

ServerErrorBody String

Instances

Eq ServerErrorBody

Defined in Symantic.HTTP.Server

Methods

(==) :: ServerErrorBody -> ServerErrorBody -> Bool

(/=) :: ServerErrorBody -> ServerErrorBody -> Bool

Show ServerErrorBody

Defined in Symantic.HTTP.Server

Methods

showsPrec :: Int -> ServerErrorBody -> ShowS

show :: ServerErrorBody -> String

showList :: [ServerErrorBody] -> ShowS

Type ServerBodyArg

newtype ServerBodyArg (ts :: [*]) a

Constructors

ServerBodyArg a

Type ServerBodyStreamArg

newtype ServerBodyStreamArg as (ts :: [*]) framing

Constructors

ServerBodyStreamArg as

Type ServerRes

newtype ServerRes (ts :: [*]) m a

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)

Defined in Symantic.HTTP.Server

Methods

lift :: Monad m => m a -> ServerRes ts m a

Monad m => Monad (ServerRes ts m)

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)

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)

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)

All supported effects are handled by nested Monads.

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))))

Type ServerResStream

Carrying the framing type variable to server.

Carrying the ts type variable to server.

Providing a return for the simple response case

newtype ServerResStream framing (ts :: [*]) m as

Constructors

ServerResponseStream

Fields

• unServerResponseStream :: m as

Instances

MonadTrans (ServerResStream framing ts)

Defined in Symantic.HTTP.Server

Methods

lift :: Monad m => m a -> ServerResStream framing ts m a

Monad m => Monad (ServerResStream framing ts m)

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)

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)

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)

All supported effects are handled by nested Monads.

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))))

Orphan instances

Semigroup Status

Return worse Status.

Methods

(<>) :: Status -> Status -> Status

sconcat :: NonEmpty Status -> Status

stimes :: Integral b => b -> Status -> Status

Monoid Status

Useful when Status is within a WriterT.

Methods

mempty :: Status

mappend :: Status -> Status -> Status

mconcat :: [Status] -> Status