Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Internal.Types

Contents

types
constructors
responses
WAI
utils

Description

Internal types and functions

Synopsis

newtype Server m = Server {
- unServer :: Req -> m (Maybe Resp)
}
data Req = Req {
- path :: [Text]
- query :: QueryMap
- headers :: RequestHeaders
- method :: Method
- readBody :: IO (Either (Error Text) ByteString)
}
data Resp = Resp {
- status :: Status
- headers :: ResponseHeaders
- body :: RespBody
}
data RespBody
- = TextResp Text
- | HtmlResp Html
- | JsonResp Value
- | FileResp FilePath
- | StreamResp
- | RawResp ByteString
type QueryMap = Map ByteString ByteString
class ToText a where
- toText :: a -> Text
data Error a = Error {
- status :: Status
- body :: a
}
toConst :: Functor m => m Resp -> Server m
toMethod :: Monad m => Method -> m Resp -> Server m
toWithBody :: MonadIO m => (ByteString -> Server m) -> Server m
toWithCapture :: Monad m => (Text -> Server m) -> Server m
toWithPath :: Monad m => Text -> Server m -> Server m
toWithHeader :: (Monad m, FromHttpApiData a) => HeaderName -> (Maybe a -> Server m) -> Server m
toWithFormData :: (FromForm a, MonadIO m) => (a -> Server m) -> Server m
toWithPathInfo :: ([Text] -> Server m) -> Server m
text :: ToText a => a -> Resp
json :: ToJSON resp => resp -> Resp
html :: ToMarkup a => a -> Resp
raw :: ByteString -> Resp
ok :: ResponseHeaders -> RespBody -> Resp
badRequest :: Text -> Resp
setContent :: ByteString -> ResponseHeaders
data ServerConfig = ServerConfig {
- maxBodySize :: Maybe Kilobytes
}
type Kilobytes = Int
toApplication :: ServerConfig -> Server IO -> Application
setRespStatus :: Status -> Resp -> Resp
handleError :: (Exception a, MonadCatch m) => (a -> Server m) -> Server m -> Server m
toResponse :: Resp -> Response
fromRequest :: Maybe Kilobytes -> Request -> IO Req
pathHead :: Req -> Maybe (Text, Req)

types

newtype Server m Source #

Server type. It is a function fron request to response. Some servers does not return valid value. We use it to find right path.

Example:

server :: Server IO
server =
  "api" /. "v1" /.
     mconcat
       [ "foo" /. (\(Query @"name" arg) -> Get  @Json (handleFoo arg)
       , "bar" /. Post @Json handleBar
       ]

handleFoo :: Int -> IO Text
handleBar :: IO Text

Note that server is monoid and it can be constructed with Monoid functions and path constructor (/.). To pass inputs for handler we can use special newtype wrappers:

Query - for required query parameters
Optional - for optional query parameters
Capture - for parsing elements of URI
Body - fot JSON-body input
RawBody - for raw ByteString input
Header - for headers

To distinguish by HTTP-method we use corresponding constructors: Get, Post, Put, etc. Let's discuss the structure of the constructor. Let's take Get for example:

newtype Get ty m a = Get (m a)

Let's look at the arguments of he type

ty - type of the response. it can be: Text, Html, Json, ByteString
m - underlying server monad
a - result type. It should be convertible to the type of the response.

also result can be wrapped to special data types to modify Http-response. we have wrappers:

SetStatus - to set status
AddHeaders - to append headers
Either (Error err) - to response with errors

Constructors

Server
Fields unServer :: Req -> m (Maybe Resp)

Instances

Instances details

Monad m => Monoid (Server m) Source #
Instance details Defined in Mig.Internal.Types Methods mempty :: Server m # mappend :: Server m -> Server m -> Server m # mconcat :: [Server m] -> Server m #
Monad m => Semigroup (Server m) Source #
Instance details Defined in Mig.Internal.Types Methods (<>) :: Server m -> Server m -> Server m # sconcat :: NonEmpty (Server m) -> Server m # stimes :: Integral b => b -> Server m -> Server m #
Monad m => ToServer (Server m) Source #
Instance details Defined in Mig Associated Types type ServerMonad (Server m) :: Type -> Type Source # Methods toServer :: Server m -> Server (ServerMonad (Server m)) Source #
type ServerMonad (Server m) Source #
Instance details Defined in Mig type ServerMonad (Server m) = m

data Req Source #

Http request

Constructors

Req
Fields path :: [Text] URI path query :: QueryMap query parameters headers :: RequestHeaders request headers method :: Method request method readBody :: IO (Either (Error Text) ByteString) lazy body reader. Error can happen if size is too big (configured on running the server)

data Resp Source #

Http response

Constructors

Resp
Fields status :: Status status headers :: ResponseHeaders headers body :: RespBody response body

Instances

Instances details

IsString Resp Source #
Instance details Defined in Mig.Internal.Types Methods fromString :: String -> Resp #

data RespBody Source #

Http response body

Constructors

TextResp Text
HtmlResp Html
JsonResp Value
FileResp FilePath
StreamResp
RawResp ByteString

type QueryMap = Map ByteString ByteString Source #

Map of query parameters for fast-access

class ToText a where Source #

Values convertible to lazy text

Methods

toText :: a -> Text Source #

Instances

Instances details

ToText Text Source #
Instance details Defined in Mig.Internal.Types Methods toText :: Text -> Text Source #
ToText Text Source #
Instance details Defined in Mig.Internal.Types Methods toText :: Text -> Text0 Source #
ToText String Source #
Instance details Defined in Mig.Internal.Types Methods toText :: String -> Text Source #
ToText Float Source #
Instance details Defined in Mig.Internal.Types Methods toText :: Float -> Text Source #
ToText Int Source #
Instance details Defined in Mig.Internal.Types Methods toText :: Int -> Text Source #

data Error a Source #

Errors

Constructors

Error
Fields status :: Status body :: a

Instances

Instances details

(Typeable a, Show a) => Exception (Error a) Source #
Instance details Defined in Mig.Internal.Types Methods toException :: Error a -> SomeException # fromException :: SomeException -> Maybe (Error a) # displayException :: Error a -> String #
Show a => Show (Error a) Source #
Instance details Defined in Mig.Internal.Types Methods showsPrec :: Int -> Error a -> ShowS # show :: Error a -> String # showList :: [Error a] -> ShowS #
(Show a, Typeable a) => HasServer (ReaderT env (ExceptT (Error a) IO)) Source #
Instance details Defined in Mig Associated Types type ServerResult (ReaderT env (ExceptT (Error a) IO)) Source # Methods renderServer :: Server (ReaderT env (ExceptT (Error a) IO)) -> ServerResult (ReaderT env (ExceptT (Error a) IO)) Source #
(ToJSON err, ToHtmlResp a) => ToHtmlResp (Either (Error err) a) Source #
Instance details Defined in Mig Methods toHtmlResp :: Either (Error err) a -> Resp Source #
(ToJSON err, ToJsonResp a) => ToJsonResp (Either (Error err) a) Source #
Instance details Defined in Mig Methods toJsonResp :: Either (Error err) a -> Resp Source #
(ToText err, ToTextResp a) => ToTextResp (Either (Error err) a) Source #
Instance details Defined in Mig Methods toTextResp :: Either (Error err) a -> Resp Source #
type ServerResult (ReaderT env (ExceptT (Error a) IO)) Source #
Instance details Defined in Mig type ServerResult (ReaderT env (ExceptT (Error a) IO)) = (Error a -> Server IO) -> env -> IO (Server IO)