Data.Greskell.GraphSON

Type

data GraphSON v

Wrapper for "typed JSON object" introduced in GraphSON version 2. See http://tinkerpop.apache.org/docs/current/dev/io/#graphson

This data type is useful for encoding/decoding GraphSON text.

>>> Aeson.decode "1000" :: Maybe (GraphSON Int32)
Just (GraphSON {gsonType = Nothing, gsonValue = 1000})
>>> Aeson.decode "{\"@type\": \"g:Int32\", \"@value\": 1000}" :: Maybe (GraphSON Int32)
Just (GraphSON {gsonType = Just "g:Int32", gsonValue = 1000})

Constructors

GraphSON

Fields

• gsonType :: Maybe Text

  Type ID, corresponding to @type field.

• gsonValue :: v

  Value, correspoding to @value field.

Instances

Functor GraphSON

Methods

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

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

Foldable GraphSON

Methods

fold :: Monoid m => GraphSON m -> m

foldMap :: Monoid m => (a -> m) -> GraphSON a -> m

foldr :: (a -> b -> b) -> b -> GraphSON a -> b

foldr' :: (a -> b -> b) -> b -> GraphSON a -> b

foldl :: (b -> a -> b) -> b -> GraphSON a -> b

foldl' :: (b -> a -> b) -> b -> GraphSON a -> b

foldr1 :: (a -> a -> a) -> GraphSON a -> a

foldl1 :: (a -> a -> a) -> GraphSON a -> a

toList :: GraphSON a -> [a]

null :: GraphSON a -> Bool

length :: GraphSON a -> Int

elem :: Eq a => a -> GraphSON a -> Bool

maximum :: Ord a => GraphSON a -> a

minimum :: Ord a => GraphSON a -> a

sum :: Num a => GraphSON a -> a

product :: Num a => GraphSON a -> a

Traversable GraphSON

Methods

traverse :: Applicative f => (a -> f b) -> GraphSON a -> f (GraphSON b)

sequenceA :: Applicative f => GraphSON (f a) -> f (GraphSON a)

mapM :: Monad m => (a -> m b) -> GraphSON a -> m (GraphSON b)

sequence :: Monad m => GraphSON (m a) -> m (GraphSON a)

Eq v => Eq (GraphSON v)

Methods

(==) :: GraphSON v -> GraphSON v -> Bool

(/=) :: GraphSON v -> GraphSON v -> Bool

Ord v => Ord (GraphSON v)

Methods

compare :: GraphSON v -> GraphSON v -> Ordering

(<) :: GraphSON v -> GraphSON v -> Bool

(<=) :: GraphSON v -> GraphSON v -> Bool

(>) :: GraphSON v -> GraphSON v -> Bool

(>=) :: GraphSON v -> GraphSON v -> Bool

max :: GraphSON v -> GraphSON v -> GraphSON v

min :: GraphSON v -> GraphSON v -> GraphSON v

Show v => Show (GraphSON v)

Methods

showsPrec :: Int -> GraphSON v -> ShowS

show :: GraphSON v -> String

showList :: [GraphSON v] -> ShowS

ToJSON v => ToJSON (GraphSON v)

If gsonType is Just, the GraphSON is encoded as a typed JSON object. If gsonType is Nothing, the gsonValue is directly encoded.

Methods

toJSON :: GraphSON v -> Value

toEncoding :: GraphSON v -> Encoding

toJSONList :: [GraphSON v] -> Value

toEncodingList :: [GraphSON v] -> Encoding

FromJSON v => FromJSON (GraphSON v)

If the given Value is a typed JSON object, gsonType field of the result is Just. Otherwise, the given Value is directly parsed into gsonValue, and gsonType is Nothing.

Methods

parseJSON :: Value -> Parser (GraphSON v)

parseJSONList :: Value -> Parser [GraphSON v]

class GraphSONTyped a where

Types that have an intrinsic type ID for gsonType field.

Minimal complete definition

gsonTypeFor

Methods

gsonTypeFor :: a -> Text

Type ID for gsonType.

Instances

GraphSONTyped Char

Methods

gsonTypeFor :: Char -> Text

GraphSONTyped Double

Methods

gsonTypeFor :: Double -> Text

GraphSONTyped Float

Methods

gsonTypeFor :: Float -> Text

GraphSONTyped Int8

Map to "gx:Byte". Note that Java's Byte is signed.

Methods

gsonTypeFor :: Int8 -> Text

GraphSONTyped Int16

Methods

gsonTypeFor :: Int16 -> Text

GraphSONTyped Int32

Methods

gsonTypeFor :: Int32 -> Text

GraphSONTyped Int64

Methods

gsonTypeFor :: Int64 -> Text

GraphSONTyped Scientific

Map to "g:Double".

Methods

gsonTypeFor :: Scientific -> Text

GraphSONTyped [a]

Methods

gsonTypeFor :: [a] -> Text

GraphSONTyped (HashSet a)

Methods

gsonTypeFor :: HashSet a -> Text

GraphSONTyped (HashMap k v)

Note that Lazy HashMap and Strict HashMap are the same data type.

Methods

gsonTypeFor :: HashMap k v -> Text

Constructors

nonTypedGraphSON :: v -> GraphSON v

Create a GraphSON without gsonType.

>>> nonTypedGraphSON (10 :: Int)
GraphSON {gsonType = Nothing, gsonValue = 10}

typedGraphSON :: GraphSONTyped v => v -> GraphSON v

Create a GraphSON with its type ID.

>>> typedGraphSON (10 :: Int32)
GraphSON {gsonType = Just "g:Int32", gsonValue = 10}

typedGraphSON' :: Text -> v -> GraphSON v

Create a GraphSON with the given type ID.

>>> typedGraphSON' "g:Int32" (10 :: Int)
GraphSON {gsonType = Just "g:Int32", gsonValue = 10}

Parser support

parseTypedGraphSON :: (GraphSONTyped v, FromJSON v) => Value -> Parser (GraphSON v)

Parse GraphSON v, but it checks gsonType. If gsonType is Nothing or it's not equal to gsonTypeFor, the Parser fails.