Maintainer	Toshio Ito <debug.ito@gmail.com>
Safe Haskell	None
Language	Haskell2010

Network.Greskell.WebSocket.Response

Contents

ResponseMessage
ResponseStatus
ResponseResult
ResponseCode

Description

Synopsis

ResponseMessage

data ResponseMessage s Source #

ResponseMessage object from Gremlin Server. See http://tinkerpop.apache.org/docs/current/dev/provider/.

Type s is the type of the response data.

Constructors

ResponseMessage
Fields requestId :: !UUID status :: !ResponseStatus result :: !(ResponseResult s)

Instances

Functor ResponseMessage Source #
Methods fmap :: (a -> b) -> ResponseMessage a -> ResponseMessage b # (<$) :: a -> ResponseMessage b -> ResponseMessage a #
Eq s => Eq (ResponseMessage s) Source #
Methods (==) :: ResponseMessage s -> ResponseMessage s -> Bool # (/=) :: ResponseMessage s -> ResponseMessage s -> Bool #
Show s => Show (ResponseMessage s) Source #
Methods showsPrec :: Int -> ResponseMessage s -> ShowS # show :: ResponseMessage s -> String # showList :: [ResponseMessage s] -> ShowS #
Generic (ResponseMessage s) Source #
Associated Types type Rep (ResponseMessage s) :: * -> * # Methods from :: ResponseMessage s -> Rep (ResponseMessage s) x # to :: Rep (ResponseMessage s) x -> ResponseMessage s #
FromGraphSON s => FromJSON (ResponseMessage s) Source #
Methods parseJSON :: Value -> Parser (ResponseMessage s) # parseJSONList :: Value -> Parser [ResponseMessage s] #
FromGraphSON s => FromGraphSON (ResponseMessage s) Source #
Methods parseGraphSON :: GValue -> Parser (ResponseMessage s) #
type Rep (ResponseMessage s) Source #
type Rep (ResponseMessage s) = D1 * (MetaData "ResponseMessage" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.0.0-B5MSDMOvrvq7G9hWTH8wEx" False) (C1 * (MetaCons "ResponseMessage" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "requestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * UUID)) ((::) (S1 * (MetaSel (Just Symbol "status") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ResponseStatus)) (S1 * (MetaSel (Just Symbol "result") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (ResponseResult s))))))

ResponseStatus

data ResponseStatus Source #

"status" field.

Constructors

ResponseStatus
Fields code :: !ResponseCode message :: !Text attributes :: !Object

Instances

Eq ResponseStatus Source #
Methods (==) :: ResponseStatus -> ResponseStatus -> Bool # (/=) :: ResponseStatus -> ResponseStatus -> Bool #
Show ResponseStatus Source #
Methods showsPrec :: Int -> ResponseStatus -> ShowS # show :: ResponseStatus -> String # showList :: [ResponseStatus] -> ShowS #
Generic ResponseStatus Source #
Associated Types type Rep ResponseStatus :: * -> * # Methods from :: ResponseStatus -> Rep ResponseStatus x # to :: Rep ResponseStatus x -> ResponseStatus #
FromJSON ResponseStatus Source #
Methods parseJSON :: Value -> Parser ResponseStatus # parseJSONList :: Value -> Parser [ResponseStatus] #
FromGraphSON ResponseStatus Source #
Methods parseGraphSON :: GValue -> Parser ResponseStatus #
type Rep ResponseStatus Source #
type Rep ResponseStatus = D1 * (MetaData "ResponseStatus" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.0.0-B5MSDMOvrvq7G9hWTH8wEx" False) (C1 * (MetaCons "ResponseStatus" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "code") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ResponseCode)) ((::) (S1 * (MetaSel (Just Symbol "message") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "attributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Object)))))

ResponseResult

data ResponseResult s Source #

"result" field.

Constructors

ResponseResult
Fields resultData :: !s "data" field. meta :: !Object

Instances

Functor ResponseResult Source #
Methods fmap :: (a -> b) -> ResponseResult a -> ResponseResult b # (<$) :: a -> ResponseResult b -> ResponseResult a #
Eq s => Eq (ResponseResult s) Source #
Methods (==) :: ResponseResult s -> ResponseResult s -> Bool # (/=) :: ResponseResult s -> ResponseResult s -> Bool #
Show s => Show (ResponseResult s) Source #
Methods showsPrec :: Int -> ResponseResult s -> ShowS # show :: ResponseResult s -> String # showList :: [ResponseResult s] -> ShowS #
Generic (ResponseResult s) Source #
Associated Types type Rep (ResponseResult s) :: * -> * # Methods from :: ResponseResult s -> Rep (ResponseResult s) x # to :: Rep (ResponseResult s) x -> ResponseResult s #
FromGraphSON s => FromJSON (ResponseResult s) Source #
Methods parseJSON :: Value -> Parser (ResponseResult s) # parseJSONList :: Value -> Parser [ResponseResult s] #
FromGraphSON s => FromGraphSON (ResponseResult s) Source #
Methods parseGraphSON :: GValue -> Parser (ResponseResult s) #
type Rep (ResponseResult s) Source #
type Rep (ResponseResult s) = D1 * (MetaData "ResponseResult" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.0.0-B5MSDMOvrvq7G9hWTH8wEx" False) (C1 * (MetaCons "ResponseResult" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "resultData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * s)) (S1 * (MetaSel (Just Symbol "meta") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Object))))

ResponseCode

data ResponseCode Source #

Response status code

Constructors

Success
NoContent
PartialContent
Unauthorized
Authenticate
MalformedRequest
InvalidRequestArguments
ServerError
ScriptEvaluationError
ServerTimeout
ServerSerializationError

Instances

Bounded ResponseCode Source #
Methods minBound :: ResponseCode # maxBound :: ResponseCode #
Enum ResponseCode Source #
Methods succ :: ResponseCode -> ResponseCode # pred :: ResponseCode -> ResponseCode # toEnum :: Int -> ResponseCode # fromEnum :: ResponseCode -> Int # enumFrom :: ResponseCode -> [ResponseCode] # enumFromThen :: ResponseCode -> ResponseCode -> [ResponseCode] # enumFromTo :: ResponseCode -> ResponseCode -> [ResponseCode] # enumFromThenTo :: ResponseCode -> ResponseCode -> ResponseCode -> [ResponseCode] #
Eq ResponseCode Source #
Methods (==) :: ResponseCode -> ResponseCode -> Bool # (/=) :: ResponseCode -> ResponseCode -> Bool #
Ord ResponseCode Source #
Methods compare :: ResponseCode -> ResponseCode -> Ordering # (<) :: ResponseCode -> ResponseCode -> Bool # (<=) :: ResponseCode -> ResponseCode -> Bool # (>) :: ResponseCode -> ResponseCode -> Bool # (>=) :: ResponseCode -> ResponseCode -> Bool # max :: ResponseCode -> ResponseCode -> ResponseCode # min :: ResponseCode -> ResponseCode -> ResponseCode #
Show ResponseCode Source #
Methods showsPrec :: Int -> ResponseCode -> ShowS # show :: ResponseCode -> String # showList :: [ResponseCode] -> ShowS #
ToJSON ResponseCode Source #
Methods toJSON :: ResponseCode -> Value # toEncoding :: ResponseCode -> Encoding # toJSONList :: [ResponseCode] -> Value # toEncodingList :: [ResponseCode] -> Encoding #
FromJSON ResponseCode Source #
Methods parseJSON :: Value -> Parser ResponseCode # parseJSONList :: Value -> Parser [ResponseCode] #
FromGraphSON ResponseCode Source #
Methods parseGraphSON :: GValue -> Parser ResponseCode #

codeToInt :: ResponseCode -> Int Source #

codeFromInt :: Int -> Maybe ResponseCode Source #

isTerminating :: ResponseCode -> Bool Source #

Returns True if the ResponseCode is a terminating code.

isSuccess :: ResponseCode -> Bool Source #

Returns True if the ResponseCode is a success.

>>> isSuccess Success
True
>>> isSuccess Unauthorized
False
>>> isSuccess ServerError
False

isClientSideError :: ResponseCode -> Bool Source #

Returns True if the ResponseCode is a client-side failure.

>>> isClientSideError Success
False
>>> isClientSideError Unauthorized
True
>>> isClientSideError ServerError
False

isServerSideError :: ResponseCode -> Bool Source #

Returns True if the ResponseCode is a server-side failure.

>>> isServerSideError Success
False
>>> isServerSideError Unauthorized
False
>>> isServerSideError ServerError
True