greskell-websocket-1.0.0.4: Haskell client for Gremlin Server using WebSocket serializer

Maintainer	Toshio Ito <[email protected]>
Safe Haskell	None
Language	Haskell2010

Network.Greskell.WebSocket.Response

Contents

ResponseMessage
ResponseStatus
ResponseResult
ResponseCode

Description

Synopsis

data ResponseMessage s = ResponseMessage {
- requestId :: !UUID
- status :: !ResponseStatus
- result :: !(ResponseResult s)
}
data ResponseStatus = ResponseStatus {
- code :: !ResponseCode
- message :: !Text
- attributes :: !Object
}
data ResponseResult s = ResponseResult {
- resultData :: !s
- meta :: !Object
}
data ResponseCode
- = Success
- | NoContent
- | PartialContent
- | Unauthorized
- | Authenticate
- | MalformedRequest
- | InvalidRequestArguments
- | ServerError
- | ScriptEvaluationError
- | ServerTimeout
- | ServerSerializationError
codeToInt :: ResponseCode -> Int
codeFromInt :: Int -> Maybe ResponseCode
isTerminating :: ResponseCode -> Bool
isSuccess :: ResponseCode -> Bool
isClientSideError :: ResponseCode -> Bool
isServerSideError :: ResponseCode -> Bool

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

Instances details

Functor ResponseMessage Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

fmap :: (a -> b) -> ResponseMessage a -> ResponseMessage b #

(<$) :: a -> ResponseMessage b -> ResponseMessage a #

FromGraphSON s => FromJSON (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser (ResponseMessage s) #

parseJSONList :: Value -> Parser [ResponseMessage s] #

omittedField :: Maybe (ResponseMessage s) #

Generic (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep (ResponseMessage s)

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseMessage s) = D1 ('MetaData "ResponseMessage" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UUID) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ResponseStatus) :*: S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResponseResult s)))))

Methods

from :: ResponseMessage s -> Rep (ResponseMessage s) x #

to :: Rep (ResponseMessage s) x -> ResponseMessage s #

Show s => Show (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseMessage s -> ShowS #

show :: ResponseMessage s -> String #

showList :: [ResponseMessage s] -> ShowS #

Eq s => Eq (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

(==) :: ResponseMessage s -> ResponseMessage s -> Bool #

(/=) :: ResponseMessage s -> ResponseMessage s -> Bool #

FromGraphSON s => FromGraphSON (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser (ResponseMessage s) #

type Rep (ResponseMessage s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseMessage s) = D1 ('MetaData "ResponseMessage" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UUID) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ResponseStatus) :*: S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResponseResult s)))))

ResponseStatus

data ResponseStatus Source #

"status" field.

Constructors

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

Instances

Instances details

FromJSON ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser ResponseStatus #

parseJSONList :: Value -> Parser [ResponseStatus] #

omittedField :: Maybe ResponseStatus #

Generic ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep ResponseStatus

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep ResponseStatus = D1 ('MetaData "ResponseStatus" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseStatus" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ResponseCode) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object))))

Methods

from :: ResponseStatus -> Rep ResponseStatus x #

to :: Rep ResponseStatus x -> ResponseStatus #

Show ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseStatus -> ShowS #

show :: ResponseStatus -> String #

showList :: [ResponseStatus] -> ShowS #

Eq ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

(==) :: ResponseStatus -> ResponseStatus -> Bool #

(/=) :: ResponseStatus -> ResponseStatus -> Bool #

FromGraphSON ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser ResponseStatus #

type Rep ResponseStatus Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep ResponseStatus = D1 ('MetaData "ResponseStatus" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseStatus" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ResponseCode) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object))))

ResponseResult

data ResponseResult s Source #

"result" field.

Constructors

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

Instances

Instances details

Functor ResponseResult Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

fmap :: (a -> b) -> ResponseResult a -> ResponseResult b #

(<$) :: a -> ResponseResult b -> ResponseResult a #

FromGraphSON s => FromJSON (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser (ResponseResult s) #

parseJSONList :: Value -> Parser [ResponseResult s] #

omittedField :: Maybe (ResponseResult s) #

Generic (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep (ResponseResult s)

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseResult s) = D1 ('MetaData "ResponseResult" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 s) :*: S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object)))

Methods

from :: ResponseResult s -> Rep (ResponseResult s) x #

to :: Rep (ResponseResult s) x -> ResponseResult s #

Show s => Show (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseResult s -> ShowS #

show :: ResponseResult s -> String #

showList :: [ResponseResult s] -> ShowS #

Eq s => Eq (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

(==) :: ResponseResult s -> ResponseResult s -> Bool #

(/=) :: ResponseResult s -> ResponseResult s -> Bool #

FromGraphSON s => FromGraphSON (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser (ResponseResult s) #

type Rep (ResponseResult s) Source #

Instance details

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseResult s) = D1 ('MetaData "ResponseResult" "Network.Greskell.WebSocket.Response" "greskell-websocket-1.0.0.4-dAG1DwqLhf87JipQDQuZQ" 'False) (C1 ('MetaCons "ResponseResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 s) :*: S1 ('MetaSel ('Just "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

Instances details

FromJSON ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response Methods parseJSON :: Value -> Parser ResponseCode # parseJSONList :: Value -> Parser [ResponseCode] # omittedField :: Maybe ResponseCode #
ToJSON ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response Methods toJSON :: ResponseCode -> Value # toEncoding :: ResponseCode -> Encoding # toJSONList :: [ResponseCode] -> Value # toEncodingList :: [ResponseCode] -> Encoding # omitField :: ResponseCode -> Bool #
Bounded ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response Methods minBound :: ResponseCode # maxBound :: ResponseCode #
Enum ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response 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] #
Show ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response Methods showsPrec :: Int -> ResponseCode -> ShowS # show :: ResponseCode -> String # showList :: [ResponseCode] -> ShowS #
Eq ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response Methods (==) :: ResponseCode -> ResponseCode -> Bool # (/=) :: ResponseCode -> ResponseCode -> Bool #
Ord ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response 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 #
FromGraphSON ResponseCode Source #
Instance details Defined in Network.Greskell.WebSocket.Response 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.

isClientSideError :: ResponseCode -> Bool Source #

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

isServerSideError :: ResponseCode -> Bool Source #

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