Database.Bolt.Serialization

Documentation

class BoltValue a where

The BoltValue class describes values, that can be packed and unpacked for BOLT protocol.

Methods

pack :: a -> Put

Packs a value to ByteString

unpackT :: Get a

Unpacks in a State monad to get values from single ByteString

Instances

BoltValue Bool

Defined in Database.Bolt.Value.Instances

Methods

pack :: Bool -> Put

unpackT :: Get Bool

BoltValue Double

Defined in Database.Bolt.Value.Instances

Methods

pack :: Double -> Put

unpackT :: Get Double

BoltValue Int

Defined in Database.Bolt.Value.Instances

Methods

pack :: Int -> Put

unpackT :: Get Int

BoltValue ()

Defined in Database.Bolt.Value.Instances

Methods

pack :: () -> Put

unpackT :: Get ()

BoltValue Text

Defined in Database.Bolt.Value.Instances

Methods

pack :: Text -> Put

unpackT :: Get Text

BoltValue Value

Defined in Database.Bolt.Value.Instances

Methods

pack :: Value -> Put

unpackT :: Get Value

BoltValue Structure

Defined in Database.Bolt.Value.Instances

Methods

pack :: Structure -> Put

unpackT :: Get Structure

BoltValue a => BoltValue [a]

Defined in Database.Bolt.Value.Instances

Methods

pack :: [a] -> Put

unpackT :: Get [a]

BoltValue a => BoltValue (Map Text a)

Defined in Database.Bolt.Value.Instances

Methods

pack :: Map Text a -> Put

unpackT :: Get (Map Text a)

data UnpackT m a

The UnpackT transformer helps to unpack a set of values from one ByteString

Instances

Monad m => MonadState ByteString (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

get :: UnpackT m ByteString

put :: ByteString -> UnpackT m ()

state :: (ByteString -> (a, ByteString)) -> UnpackT m a

Monad m => MonadError UnpackError (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

throwError :: UnpackError -> UnpackT m a

catchError :: UnpackT m a -> (UnpackError -> UnpackT m a) -> UnpackT m a

Monad m => Monad (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

(>>=) :: UnpackT m a -> (a -> UnpackT m b) -> UnpackT m b

(>>) :: UnpackT m a -> UnpackT m b -> UnpackT m b

return :: a -> UnpackT m a

Functor m => Functor (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

fmap :: (a -> b) -> UnpackT m a -> UnpackT m b

(<$) :: a -> UnpackT m b -> UnpackT m a

Monad m => Applicative (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

pure :: a -> UnpackT m a

(<*>) :: UnpackT m (a -> b) -> UnpackT m a -> UnpackT m b

liftA2 :: (a -> b -> c) -> UnpackT m a -> UnpackT m b -> UnpackT m c

(*>) :: UnpackT m a -> UnpackT m b -> UnpackT m b

(<*) :: UnpackT m a -> UnpackT m b -> UnpackT m a

data UnpackError

Error during unpack process

Constructors

NotNull

NotInt

NotFloat

NotString

NotBool

NotList

NotDict

NotStructure

NotValue

BinaryError Text

Not Text

Instances

Eq UnpackError

Defined in Database.Bolt.Value.Type

Methods

(==) :: UnpackError -> UnpackError -> Bool

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

Ord UnpackError

Defined in Database.Bolt.Value.Type

Methods

compare :: UnpackError -> UnpackError -> Ordering

(<) :: UnpackError -> UnpackError -> Bool

(<=) :: UnpackError -> UnpackError -> Bool

(>) :: UnpackError -> UnpackError -> Bool

(>=) :: UnpackError -> UnpackError -> Bool

max :: UnpackError -> UnpackError -> UnpackError

min :: UnpackError -> UnpackError -> UnpackError

Show UnpackError

Defined in Database.Bolt.Value.Type

Methods

showsPrec :: Int -> UnpackError -> ShowS

show :: UnpackError -> String

showList :: [UnpackError] -> ShowS

Monad m => MonadError UnpackError (UnpackT m)

Defined in Database.Bolt.Value.Type

Methods

throwError :: UnpackError -> UnpackT m a

catchError :: UnpackT m a -> (UnpackError -> UnpackT m a) -> UnpackT m a

class ToStructure a where

Generalizes all datatypes that can be serialized to Structures.

Methods

toStructure :: a -> Structure

class FromStructure a where

Generalizes all datatypes that can be deserialized from Structures.

Methods

fromStructure :: MonadError UnpackError m => Structure -> m a

Instances

FromStructure Path

Defined in Database.Bolt.Value.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Path

FromStructure URelationship

Defined in Database.Bolt.Value.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m URelationship

FromStructure Relationship

Defined in Database.Bolt.Value.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Relationship

FromStructure Node

Defined in Database.Bolt.Value.Instances

Methods

fromStructure :: MonadError UnpackError m => Structure -> m Node

unpack :: (Monad m, BoltValue a) => ByteString -> m (Either UnpackError a)

Unpacks a ByteString to selected value

unpackF :: (MonadFail m, BoltValue a) => ByteString -> m a

Old-style unpack that runs fail on error

unpackAction :: Get a -> ByteString -> Either UnpackError a

Unpacks a ByteString to selected value by some custom action