Safe Haskell	None
Language	GHC2021

Web.Hyperbole.Effect.Server

Synopsis

data Server (a :: Type -> Type) b where
- LoadRequest :: forall (a :: Type -> Type). Server a Request
- SendResponse :: forall (a :: Type -> Type). Client -> Response -> Server a ()
runServerWai :: forall (es :: [Effect]) a. IOE :> es => (ByteString -> ByteString) -> Request -> (Response -> IO ResponseReceived) -> Eff (Server ': es) a -> Eff es (Maybe ResponseReceived)
renderCookie :: [Segment] -> Cookie -> ByteString
cookiesFromHeader :: [(ByteString, ByteString)] -> Cookies
runServerSockets :: forall (es :: [Effect]). IOE :> es => Connection -> Request -> Eff (Server ': es) Response -> Eff es Response
errNotHandled :: Event Text Text -> String
data Client = Client {
- session :: Cookies
- query :: QueryData
}
data SocketError = InvalidMessage Text
data ContentType
- = ContentHtml
- | ContentText
contentType :: ContentType -> (HeaderName, ByteString)
newtype Metadata = Metadata [(ByteString, Text)]
newtype Host = Host {
- text :: ByteString
}
data Request = Request {
- host :: Host
- path :: [Segment]
- query :: Query
- body :: ByteString
- method :: Method
- cookies :: Cookies
}
data Response
- = Response TargetViewId (View () ())
- | NotFound
- | Redirect Url
- | Err ResponseError
- | Empty
data ResponseError
- = ErrParse Text
- | ErrQuery Text
- | ErrSession Param Text
- | ErrOther Text
- | ErrNotHandled (Event Text Text)
- | ErrAuth
newtype TargetViewId = TargetViewId Text
data Event id act = Event {
- viewId :: id
- action :: act
}

Documentation

data Server (a :: Type -> Type) b where Source #

Low level effect mapping request/response to either HTTP or WebSockets

Constructors

LoadRequest :: forall (a :: Type -> Type). Server a Request
SendResponse :: forall (a :: Type -> Type). Client -> Response -> Server a ()

Instances

Instances details

type DispatchOf Server Source #
Instance details Defined in Web.Hyperbole.Effect.Server type DispatchOf Server = 'Dynamic

runServerWai :: forall (es :: [Effect]) a. IOE :> es => (ByteString -> ByteString) -> Request -> (Response -> IO ResponseReceived) -> Eff (Server ': es) a -> Eff es (Maybe ResponseReceived) Source #

renderCookie :: [Segment] -> Cookie -> ByteString Source #

cookiesFromHeader :: [(ByteString, ByteString)] -> Cookies Source #

runServerSockets :: forall (es :: [Effect]). IOE :> es => Connection -> Request -> Eff (Server ': es) Response -> Eff es Response Source #

errNotHandled :: Event Text Text -> String Source #

data Client Source #

Constructors

Client
Fields session :: Cookies query :: QueryData

data SocketError Source #

Constructors

InvalidMessage Text

Instances

Instances details

Show SocketError Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods showsPrec :: Int -> SocketError -> ShowS # show :: SocketError -> String # showList :: [SocketError] -> ShowS #
Eq SocketError Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods (==) :: SocketError -> SocketError -> Bool # (/=) :: SocketError -> SocketError -> Bool #

data ContentType Source #

Constructors

ContentHtml
ContentText

contentType :: ContentType -> (HeaderName, ByteString) Source #

newtype Metadata Source #

Constructors

Metadata [(ByteString, Text)]

Instances

Instances details

Monoid Metadata Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods mempty :: Metadata # mappend :: Metadata -> Metadata -> Metadata # mconcat :: [Metadata] -> Metadata #
Semigroup Metadata Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods (<>) :: Metadata -> Metadata -> Metadata # sconcat :: NonEmpty Metadata -> Metadata # stimes :: Integral b => b -> Metadata -> Metadata #

newtype Host Source #

Constructors

Host
Fields text :: ByteString

Instances

Instances details

Show Host Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #

data Request Source #

Constructors

Request
Fields host :: Host path :: [Segment] query :: Query body :: ByteString method :: Method cookies :: Cookies

Instances

Instances details

Show Request Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #

data Response Source #

Valid responses for a Hyperbole effect. Use notFound, etc instead.

Constructors

Response TargetViewId (View () ())
NotFound
Redirect Url
Err ResponseError
Empty

data ResponseError Source #

Constructors

ErrParse Text
ErrQuery Text
ErrSession Param Text
ErrOther Text
ErrNotHandled (Event Text Text)
ErrAuth

Instances

Instances details

Show ResponseError Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods showsPrec :: Int -> ResponseError -> ShowS # show :: ResponseError -> String # showList :: [ResponseError] -> ShowS #

newtype TargetViewId Source #

Serialized ViewId

Constructors

TargetViewId Text

data Event id act Source #

An action, with its corresponding id

Constructors

Event
Fields viewId :: id action :: act

Instances

Instances details

(Show act, Show id) => Show (Event id act) Source #
Instance details Defined in Web.Hyperbole.Effect.Server Methods showsPrec :: Int -> Event id act -> ShowS # show :: Event id act -> String # showList :: [Event id act] -> ShowS #