Servant.Subscriber.Response

Documentation

type ResponseHeader = RequestHeader

type ResponseHeaders = RequestHeaders

data Response

Any message from the server is a Response.

Subscribed: Resource was successfully subscribed

Modified: Resource was modified (this message is also triggered immediately after a subscription)

HttpRequestFailed: The server replied with some none 2xx status code. Thus your subscription failed or got removed.

ParseError: Your request could not be parsed.

Constructors

Subscribed !HttpRequest

Modified !HttpRequest !ResponseBody

Deleted !Path

Unsubscribed !HttpRequest

HttpRequestFailed !HttpRequest !HttpResponse

ParseError

Instances

Generic Response

Associated Types

type Rep Response :: * -> *

Methods

from :: Response -> Rep Response x

to :: Rep Response x -> Response

ToJSON Response

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

type Rep Response

type Rep Response = D1 (MetaData "Response" "Servant.Subscriber.Response" "servant-subscriber-0.6.0.1-61EPyOtv8bEcXLjl4joX9" False) ((:+:) ((:+:) (C1 (MetaCons "Subscribed" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest))) ((:+:) (C1 (MetaCons "Modified" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseBody)))) (C1 (MetaCons "Deleted" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Path))))) ((:+:) (C1 (MetaCons "Unsubscribed" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest))) ((:+:) (C1 (MetaCons "HttpRequestFailed" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpResponse)))) (C1 (MetaCons "ParseError" PrefixI False) U1))))

data HttpResponse

Constructors

HttpResponse

Fields

• httpStatus :: !Status
• httpHeaders :: !ResponseHeaders
• httpBody :: !ResponseBody

Instances

Generic HttpResponse

Associated Types

type Rep HttpResponse :: * -> *

Methods

from :: HttpResponse -> Rep HttpResponse x

to :: Rep HttpResponse x -> HttpResponse

ToJSON HttpResponse

Methods

toJSON :: HttpResponse -> Value

toEncoding :: HttpResponse -> Encoding

toJSONList :: [HttpResponse] -> Value

toEncodingList :: [HttpResponse] -> Encoding

type Rep HttpResponse

type Rep HttpResponse = D1 (MetaData "HttpResponse" "Servant.Subscriber.Response" "servant-subscriber-0.6.0.1-61EPyOtv8bEcXLjl4joX9" False) (C1 (MetaCons "HttpResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "httpStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Status)) ((:*:) (S1 (MetaSel (Just Symbol "httpHeaders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseHeaders)) (S1 (MetaSel (Just Symbol "httpBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseBody)))))

data Status

Constructors

Status

Fields

• statusCode :: !Int
• statusMessage :: !Text

Instances

Show Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

Generic Status

Associated Types

type Rep Status :: * -> *

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

ToJSON Status

Methods

toJSON :: Status -> Value

toEncoding :: Status -> Encoding

toJSONList :: [Status] -> Value

toEncodingList :: [Status] -> Encoding

type Rep Status

type Rep Status = D1 (MetaData "Status" "Servant.Subscriber.Response" "servant-subscriber-0.6.0.1-61EPyOtv8bEcXLjl4joX9" False) (C1 (MetaCons "Status" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "statusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "statusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type ResponseBody = Text

fromHTTPHeader :: Header -> ResponseHeader

fromHTTPHeaders :: ResponseHeaders -> ResponseHeaders

fromHTTPStatus :: Status -> Status

fromServantError :: ServantErr -> HttpResponse

wrapInString :: Builder -> Builder