greskell-core-1.0.0.4: Haskell binding for Gremlin graph query language - core data types and tools
MaintainerToshio Ito <[email protected]>
Safe HaskellNone
LanguageHaskell2010

Data.Greskell.GraphSON.GValue

Description

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

Synopsis

GValue type

newtype GValue Source #

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

Instances

Instances details
FromJSON GValue Source #

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

Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

parseJSON :: Value -> Parser GValue #

parseJSONList :: Value -> Parser [GValue] #

omittedField :: Maybe GValue #

ToJSON GValue Source #

Reconstruct Value from GValue. It preserves all GraphSON wrappers.

Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

toJSON :: GValue -> Value #

toEncoding :: GValue -> Encoding #

toJSONList :: [GValue] -> Value #

toEncodingList :: [GValue] -> Encoding #

omitField :: GValue -> Bool #

Generic GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Associated Types

type Rep GValue 
Instance details

Defined in Data.Greskell.GraphSON.GValue

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

Methods

from :: GValue -> Rep GValue x #

to :: Rep GValue x -> GValue #

Show GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

showsPrec :: Int -> GValue -> ShowS #

show :: GValue -> String #

showList :: [GValue] -> ShowS #

Eq GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

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

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

FromGraphSON GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON

Methods

parseGraphSON :: GValue -> Parser GValue Source #

Hashable GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

hashWithSalt :: Int -> GValue -> Int #

hash :: GValue -> Int #

type Rep GValue Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

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

data GValueBody Source #

GValue without the top-level GraphSON wrapper.

Since: 1.0.0.0

Constructors

GObject !(KeyMap GValue) 
GArray !(Vector GValue) 
GString !Text 
GNumber !Scientific 
GBool !Bool 
GNull 

Instances

Instances details
ToJSON GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

toJSON :: GValueBody -> Value #

toEncoding :: GValueBody -> Encoding #

toJSONList :: [GValueBody] -> Value #

toEncodingList :: [GValueBody] -> Encoding #

omitField :: GValueBody -> Bool #

Generic GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Associated Types

type Rep GValueBody 
Instance details

Defined in Data.Greskell.GraphSON.GValue

type Rep GValueBody = D1 ('MetaData "GValueBody" "Data.Greskell.GraphSON.GValue" "greskell-core-1.0.0.4-AzMvrVXZTMYEQgM8wjhwer" 'False) ((C1 ('MetaCons "GObject" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyMap GValue))) :+: (C1 ('MetaCons "GArray" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Vector GValue))) :+: C1 ('MetaCons "GString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "GNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "GBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "GNull" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: GValueBody -> Rep GValueBody x #

to :: Rep GValueBody x -> GValueBody #

Show GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

showsPrec :: Int -> GValueBody -> ShowS #

show :: GValueBody -> String #

showList :: [GValueBody] -> ShowS #

Eq GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

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

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

Hashable GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

Methods

hashWithSalt :: Int -> GValueBody -> Int #

hash :: GValueBody -> Int #

type Rep GValueBody Source # 
Instance details

Defined in Data.Greskell.GraphSON.GValue

type Rep GValueBody = D1 ('MetaData "GValueBody" "Data.Greskell.GraphSON.GValue" "greskell-core-1.0.0.4-AzMvrVXZTMYEQgM8wjhwer" 'False) ((C1 ('MetaCons "GObject" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyMap GValue))) :+: (C1 ('MetaCons "GArray" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Vector GValue))) :+: C1 ('MetaCons "GString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "GNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "GBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "GNull" 'PrefixI 'False) (U1 :: Type -> Type))))

constructors

nonTypedGValue :: GValueBody -> GValue Source #

Create a GValue without "@type" field.

Since: 0.1.2.0

typedGValue' Source #

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 Source #

Remove all GraphSON wrappers recursively from GValue.

Since: 0.1.2.0

unwrapOne :: GValue -> Value Source #

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 Source #

Get the GValueBody from GValue.

Since: 0.1.2.0

gValueType :: GValue -> Maybe Text Source #

Get the gsonType field from GValue.

Since: 0.1.2.0