Safe Haskell	Safe-Inferred
Language	Haskell2010

Servant.Subscriber.Request

Synopsis

type RequestHeader = (Text, Text)
type RequestHeaders = [RequestHeader]
data Request
- = Subscribe !HttpRequest
- | Unsubscribe !HttpRequest
- | SetPongRequest !HttpRequest
- | SetCloseRequest !HttpRequest
data HttpRequest = HttpRequest {
- httpMethod :: !Text
- httpPath :: !Path
- httpHeaders :: RequestHeaders
- httpQuery :: QueryText
- httpBody :: RequestBody
}
newtype RequestBody = RequestBody Text
runRequestBody :: RequestBody -> Text
toHTTPHeader :: RequestHeader -> Header
toHTTPHeaders :: RequestHeaders -> RequestHeaders
requestPath :: Request -> Path

Documentation

type RequestHeader = (Text, Text) Source #

type RequestHeaders = [RequestHeader] Source #

data Request Source #

Any message from the client is a Request:

SetPongRequest: A request that should be issued whenever a websocket pong is received. In addition to every websocket pong the request also gets issued immediately upon receival. Bot SetPongRequest and SetCloseRequest will be confirmed with a Subscribed response, but any return value of the request won't be delivered.

SetCloseRequest: A request that should be issued when the websocket connection closes for whatever reason.

Constructors

Subscribe !HttpRequest
Unsubscribe !HttpRequest
SetPongRequest !HttpRequest
SetCloseRequest !HttpRequest

Instances

Instances details

FromJSON Request Source #
Instance details Defined in Servant.Subscriber.Request Methods parseJSON :: Value -> Parser Request # parseJSONList :: Value -> Parser [Request] #
ToJSON Request Source #
Instance details Defined in Servant.Subscriber.Request Methods toJSON :: Request -> Value # toEncoding :: Request -> Encoding # toJSONList :: [Request] -> Value # toEncodingList :: [Request] -> Encoding #
Generic Request Source #
Instance details Defined in Servant.Subscriber.Request Associated Types type Rep Request :: Type -> Type # Methods from :: Request -> Rep Request x # to :: Rep Request x -> Request #
type Rep Request Source #
Instance details Defined in Servant.Subscriber.Request type Rep Request = D1 ('MetaData "Request" "Servant.Subscriber.Request" "servant-subscriber-0.7.0.0-Eb9O07bMvVi18us1BTwO3F" 'False) ((C1 ('MetaCons "Subscribe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HttpRequest)) :+: C1 ('MetaCons "Unsubscribe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HttpRequest))) :+: (C1 ('MetaCons "SetPongRequest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HttpRequest)) :+: C1 ('MetaCons "SetCloseRequest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HttpRequest))))

data HttpRequest Source #

Constructors

HttpRequest
Fields httpMethod :: !Text httpPath :: !Path httpHeaders :: RequestHeaders httpQuery :: QueryText httpBody :: RequestBody

Instances

Instances details

FromJSON HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Methods parseJSON :: Value -> Parser HttpRequest # parseJSONList :: Value -> Parser [HttpRequest] #
ToJSON HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Methods toJSON :: HttpRequest -> Value # toEncoding :: HttpRequest -> Encoding # toJSONList :: [HttpRequest] -> Value # toEncodingList :: [HttpRequest] -> Encoding #
Generic HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Associated Types type Rep HttpRequest :: Type -> Type # Methods from :: HttpRequest -> Rep HttpRequest x # to :: Rep HttpRequest x -> HttpRequest #
Show HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Methods showsPrec :: Int -> HttpRequest -> ShowS # show :: HttpRequest -> String # showList :: [HttpRequest] -> ShowS #
Eq HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Methods (==) :: HttpRequest -> HttpRequest -> Bool # (/=) :: HttpRequest -> HttpRequest -> Bool #
Ord HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request Methods compare :: HttpRequest -> HttpRequest -> Ordering # (<) :: HttpRequest -> HttpRequest -> Bool # (<=) :: HttpRequest -> HttpRequest -> Bool # (>) :: HttpRequest -> HttpRequest -> Bool # (>=) :: HttpRequest -> HttpRequest -> Bool # max :: HttpRequest -> HttpRequest -> HttpRequest # min :: HttpRequest -> HttpRequest -> HttpRequest #
type Rep HttpRequest Source #
Instance details Defined in Servant.Subscriber.Request type Rep HttpRequest = D1 ('MetaData "HttpRequest" "Servant.Subscriber.Request" "servant-subscriber-0.7.0.0-Eb9O07bMvVi18us1BTwO3F" 'False) (C1 ('MetaCons "HttpRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Path)) :: (S1 ('MetaSel ('Just "httpHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RequestHeaders) :: (S1 ('MetaSel ('Just "httpQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueryText) :: S1 ('MetaSel ('Just "httpBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RequestBody)))))

newtype RequestBody Source #

Constructors

RequestBody Text

Instances

Instances details

FromJSON RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Methods parseJSON :: Value -> Parser RequestBody # parseJSONList :: Value -> Parser [RequestBody] #
ToJSON RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Methods toJSON :: RequestBody -> Value # toEncoding :: RequestBody -> Encoding # toJSONList :: [RequestBody] -> Value # toEncodingList :: [RequestBody] -> Encoding #
Generic RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Associated Types type Rep RequestBody :: Type -> Type # Methods from :: RequestBody -> Rep RequestBody x # to :: Rep RequestBody x -> RequestBody #
Show RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Methods showsPrec :: Int -> RequestBody -> ShowS # show :: RequestBody -> String # showList :: [RequestBody] -> ShowS #
Eq RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Methods (==) :: RequestBody -> RequestBody -> Bool # (/=) :: RequestBody -> RequestBody -> Bool #
Ord RequestBody Source #
Instance details Defined in Servant.Subscriber.Request Methods compare :: RequestBody -> RequestBody -> Ordering # (<) :: RequestBody -> RequestBody -> Bool # (<=) :: RequestBody -> RequestBody -> Bool # (>) :: RequestBody -> RequestBody -> Bool # (>=) :: RequestBody -> RequestBody -> Bool # max :: RequestBody -> RequestBody -> RequestBody # min :: RequestBody -> RequestBody -> RequestBody #
type Rep RequestBody Source #
Instance details Defined in Servant.Subscriber.Request type Rep RequestBody = D1 ('MetaData "RequestBody" "Servant.Subscriber.Request" "servant-subscriber-0.7.0.0-Eb9O07bMvVi18us1BTwO3F" 'True) (C1 ('MetaCons "RequestBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

runRequestBody :: RequestBody -> Text Source #

toHTTPHeader :: RequestHeader -> Header Source #

toHTTPHeaders :: RequestHeaders -> RequestHeaders Source #

requestPath :: Request -> Path Source #