Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Server.Message

Documentation

data Message Source #

Constructors

Message
Fields messageType :: Text event :: Event TargetViewId Encoded Encoded requestId :: RequestId metadata :: Metadata body :: MessageBody

Instances

Instances details

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

newtype MessageBody Source #

Constructors

MessageBody
Fields value :: ByteString

Instances

Instances details

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

data MessageError Source #

Constructors

InvalidMessage String Text
InvalidCookie ByteString String
MissingMeta String

Instances

Instances details

Exception MessageError Source #
Instance details Defined in Web.Hyperbole.Server.Message Methods toException :: MessageError -> SomeException # fromException :: SomeException -> Maybe MessageError # displayException :: MessageError -> String #
Show MessageError Source #
Instance details Defined in Web.Hyperbole.Server.Message Methods showsPrec :: Int -> MessageError -> ShowS # show :: MessageError -> String # showList :: [MessageError] -> ShowS #

mimeType :: Text Source #

parseActionMessage :: Text -> Either String Message Source #

renderMetadata :: Metadata -> Text Source #

metaLine :: MetaKey -> Text -> Text Source #

type MetaKey = Text Source #

newtype Metadata Source #

Constructors

Metadata [(Text, Text)]

Instances

Instances details

Monoid Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message Methods mempty :: Metadata # mappend :: Metadata -> Metadata -> Metadata # mconcat :: [Metadata] -> Metadata #
Semigroup Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message Methods (<>) :: Metadata -> Metadata -> Metadata # sconcat :: NonEmpty Metadata -> Metadata # stimes :: Integral b => b -> Metadata -> Metadata #
Generic Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message Associated Types type Rep Metadata :: Type -> Type # Methods from :: Metadata -> Rep Metadata x # to :: Rep Metadata x -> Metadata #
Show Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
ViewId Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message Associated Types type ViewState Metadata Source # Methods toViewId :: Metadata -> Encoded Source # parseViewId :: Encoded -> Either String Metadata Source #
type Rep Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message type Rep Metadata = D1 ('MetaData "Metadata" "Web.Hyperbole.Server.Message" "hyperbole-0.6.0-inplace" 'True) (C1 ('MetaCons "Metadata" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Text)])))
type ViewState Metadata Source #
Instance details Defined in Web.Hyperbole.Server.Message type ViewState Metadata = ()

metadata :: MetaKey -> Text -> Metadata Source #

lookupMetadata :: MetaKey -> Metadata -> Maybe Text Source #

requestMetadata :: Request -> Metadata Source #

targetViewMetadata :: TargetViewId -> Metadata Source #

responseMetadata :: Path -> Client -> [Remote] -> Metadata Source #

clientMetadata :: Path -> Client -> Metadata Source #

metaRemotes :: [Remote] -> Metadata Source #

metaError :: Text -> Metadata Source #

data ContentType Source #

Constructors

ContentHtml
ContentText

data RenderedMessage Source #

Constructors

MessageHtml ByteString
MessageText Text