Network.Greskell.WebSocket.Response

ResponseMessage

data ResponseMessage s

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

Defined in Network.Greskell.WebSocket.Response

Methods

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

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

Eq s => Eq (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

Methods

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

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

Show s => Show (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseMessage s -> ShowS

show :: ResponseMessage s -> String

showList :: [ResponseMessage s] -> ShowS

Generic (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep (ResponseMessage s) :: Type -> Type

Methods

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

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

FromGraphSON s => FromJSON (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser (ResponseMessage s)

parseJSONList :: Value -> Parser [ResponseMessage s]

FromGraphSON s => FromGraphSON (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser (ResponseMessage s)

type Rep (ResponseMessage s)

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseMessage s) = D1 (MetaData "ResponseMessage" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.2.1-ClPDYsOVjQKKyFTbg45sNl" 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

"status" field.

Constructors

ResponseStatus

Fields

• code :: !ResponseCode
• message :: !Text
• attributes :: !Object

Instances

Eq ResponseStatus

Defined in Network.Greskell.WebSocket.Response

Methods

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

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

Show ResponseStatus

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseStatus -> ShowS

show :: ResponseStatus -> String

showList :: [ResponseStatus] -> ShowS

Generic ResponseStatus

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep ResponseStatus :: Type -> Type

Methods

from :: ResponseStatus -> Rep ResponseStatus x

to :: Rep ResponseStatus x -> ResponseStatus

FromJSON ResponseStatus

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser ResponseStatus

parseJSONList :: Value -> Parser [ResponseStatus]

FromGraphSON ResponseStatus

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser ResponseStatus

type Rep ResponseStatus

Defined in Network.Greskell.WebSocket.Response

type Rep ResponseStatus = D1 (MetaData "ResponseStatus" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.2.1-ClPDYsOVjQKKyFTbg45sNl" 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

"result" field.

Constructors

ResponseResult

Fields

• resultData :: !s

  "data" field.

• meta :: !Object

Instances

Functor ResponseResult

Defined in Network.Greskell.WebSocket.Response

Methods

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

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

Eq s => Eq (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

Methods

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

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

Show s => Show (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseResult s -> ShowS

show :: ResponseResult s -> String

showList :: [ResponseResult s] -> ShowS

Generic (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

Associated Types

type Rep (ResponseResult s) :: Type -> Type

Methods

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

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

FromGraphSON s => FromJSON (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser (ResponseResult s)

parseJSONList :: Value -> Parser [ResponseResult s]

FromGraphSON s => FromGraphSON (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser (ResponseResult s)

type Rep (ResponseResult s)

Defined in Network.Greskell.WebSocket.Response

type Rep (ResponseResult s) = D1 (MetaData "ResponseResult" "Network.Greskell.WebSocket.Response" "greskell-websocket-0.1.2.1-ClPDYsOVjQKKyFTbg45sNl" 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

Response status code

Constructors

Success

NoContent

PartialContent

Unauthorized

Authenticate

MalformedRequest

InvalidRequestArguments

ServerError

ScriptEvaluationError

ServerTimeout

ServerSerializationError

Instances

Bounded ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

minBound :: ResponseCode

maxBound :: ResponseCode

Enum ResponseCode

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]

Eq ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

(==) :: ResponseCode -> ResponseCode -> Bool

(/=) :: ResponseCode -> ResponseCode -> Bool

Ord ResponseCode

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

Show ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

showsPrec :: Int -> ResponseCode -> ShowS

show :: ResponseCode -> String

showList :: [ResponseCode] -> ShowS

ToJSON ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

toJSON :: ResponseCode -> Value

toEncoding :: ResponseCode -> Encoding

toJSONList :: [ResponseCode] -> Value

toEncodingList :: [ResponseCode] -> Encoding

FromJSON ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

parseJSON :: Value -> Parser ResponseCode

parseJSONList :: Value -> Parser [ResponseCode]

FromGraphSON ResponseCode

Defined in Network.Greskell.WebSocket.Response

Methods

parseGraphSON :: GValue -> Parser ResponseCode

codeToInt :: ResponseCode -> Int

codeFromInt :: Int -> Maybe ResponseCode

isTerminating :: ResponseCode -> Bool

Returns True if the ResponseCode is a terminating code.

isSuccess :: ResponseCode -> Bool

Returns True if the ResponseCode is a success.

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

isClientSideError :: ResponseCode -> Bool

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

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

isServerSideError :: ResponseCode -> Bool

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

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