Data.Greskell.GraphSON.GValue

This module is for advanced use. Most users should just use Data.Greskell.GraphSON.

This module defines GValue and exposes its deconstructors.

Since: 0.1.2.0

GValue type

newtype GValue

An Aeson Value wrapped in GraphSON wrapper type. Basically this type is the Haskell representaiton of a GraphSON-encoded document.

This type is used to parse GraphSON documents. See also FromGraphSON class.

Since: 0.1.2.0

Constructors

GValue

Fields

• unGValue :: GraphSON GValueBody

Instances

Eq GValue

Methods

(==) :: GValue -> GValue -> Bool

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

Show GValue

Methods

showsPrec :: Int -> GValue -> ShowS

show :: GValue -> String

showList :: [GValue] -> ShowS

Generic GValue

Associated Types

type Rep GValue :: * -> *

Methods

from :: GValue -> Rep GValue x

to :: Rep GValue x -> GValue

Hashable GValue

Methods

hashWithSalt :: Int -> GValue -> Int

hash :: GValue -> Int

ToJSON GValue

Reconstruct Value from GValue. It preserves all GraphSON wrappers.

Methods

toJSON :: GValue -> Value

toEncoding :: GValue -> Encoding

toJSONList :: [GValue] -> Value

toEncodingList :: [GValue] -> Encoding

FromJSON GValue

Parse GraphSON wrappers recursively in Value, making it into GValue.

Methods

parseJSON :: Value -> Parser GValue

parseJSONList :: Value -> Parser [GValue]

FromGraphSON GValue

Methods

parseGraphSON :: GValue -> Parser GValue

type Rep GValue

type Rep GValue = D1 * (MetaData "GValue" "Data.Greskell.GraphSON.GValue" "greskell-core-0.1.2.1-FYeBSfof15d2XMYaMpNNBY" True) (C1 * (MetaCons "GValue" PrefixI True) (S1 * (MetaSel (Just Symbol "unGValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (GraphSON GValueBody))))

data GValueBody

GValue without the top-level GraphSON wrapper.

Since: 0.1.2.0

Constructors

GObject !(HashMap Text GValue)

GArray !(Vector GValue)

GString !Text

GNumber !Scientific

GBool !Bool

GNull

Instances

Eq GValueBody

Methods

(==) :: GValueBody -> GValueBody -> Bool

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

Show GValueBody

Methods

showsPrec :: Int -> GValueBody -> ShowS

show :: GValueBody -> String

showList :: [GValueBody] -> ShowS

Generic GValueBody

Associated Types

type Rep GValueBody :: * -> *

Methods

from :: GValueBody -> Rep GValueBody x

to :: Rep GValueBody x -> GValueBody

Hashable GValueBody

Methods

hashWithSalt :: Int -> GValueBody -> Int

hash :: GValueBody -> Int

ToJSON GValueBody

Methods

toJSON :: GValueBody -> Value

toEncoding :: GValueBody -> Encoding

toJSONList :: [GValueBody] -> Value

toEncodingList :: [GValueBody] -> Encoding

type Rep GValueBody

type Rep GValueBody = D1 * (MetaData "GValueBody" "Data.Greskell.GraphSON.GValue" "greskell-core-0.1.2.1-FYeBSfof15d2XMYaMpNNBY" False) ((:+:) * ((:+:) * (C1 * (MetaCons "GObject" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (HashMap Text GValue)))) ((:+:) * (C1 * (MetaCons "GArray" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector GValue)))) (C1 * (MetaCons "GString" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))) ((:+:) * (C1 * (MetaCons "GNumber" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Scientific))) ((:+:) * (C1 * (MetaCons "GBool" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool))) (C1 * (MetaCons "GNull" PrefixI False) (U1 *)))))

constructors

nonTypedGValue :: GValueBody -> GValue

Create a GValue without "@type" field.

Since: 0.1.2.0

typedGValue'

Arguments

:: Text

"@type" field.

-> GValueBody

-> GValue

Create a GValue with the given "@type" field.

Since: 0.1.2.0

deconstructors

In most cases, you should not use these deconstructors. That is because internal structure of GValue may vary depending on the Gremlin server instance and its serializer. You should instead use parsers based on FromGraphSON class, such as parseEither.

If you are implementing parsers for GraphSON objects described in Gremlin IO Reference (http://tinkerpop.apache.org/docs/current/dev/io/), you may use these descructors.

unwrapAll :: GValue -> Value

Remove all GraphSON wrappers recursively from GValue.

Since: 0.1.2.0

unwrapOne :: GValue -> Value

Remove the top-level GraphSON wrapper, but leave other wrappers as-is. The remaining wrappers are reconstructed by toJSON to make them into Value.

Since: 0.1.2.0

gValueBody :: GValue -> GValueBody

Get the GValueBody from GValue.

Since: 0.1.2.0

gValueType :: GValue -> Maybe Text

Get the gsonType field from GValue.

Since: 0.1.2.0