Safe Haskell	None
Language	Haskell98

Network.Riak.CRDT.Types

Contents

Types
Misc

Description

Haskell-side view of CRDT

Synopsis

Types

data DataType Source

CRDT ADT.

get operations return value of this type

Constructors

DTCounter Counter
DTSet Set
DTMap Map

Instances

Eq DataType
Show DataType
Generic DataType
NFData DataType
type Rep DataType

Counters

newtype Counter Source

CRDT Counter hold a integer Count

>>> Counter 42

Constructors

Counter Count

Instances

Eq Counter
Num Counter
Ord Counter
Show Counter
Generic Counter
Monoid Counter
NFData Counter
Semigroup Counter
Default Counter
CRDT Counter CounterOp
type Rep Counter

type Count = Int64 Source

Modification

data CounterOp Source

Counters can be incremented/decremented

>>> CounterInc 1

Constructors

CounterInc !Count

Instances

Eq CounterOp
Show CounterOp
Monoid CounterOp
CRDT Counter CounterOp

Sets

newtype Set Source

CRDT Set is a Data.Set

>>> Set (Data.Set.fromList ["foo","bar"])

Constructors

Set (Set ByteString)

Instances

Eq Set
Ord Set
Show Set
Generic Set
Monoid Set
NFData Set
Semigroup Set
Default Set
CRDT Set SetOp
type Rep Set

Modification

data SetOp Source

CRDT Set operations

Constructors

SetAdd ByteString

add element to the set

>>> SetAdd "foo"

SetRemove ByteString

remove element from the set

>>> SetRemove "bar"

Instances

Eq SetOp
Show SetOp
CRDT Set SetOp

Maps

newtype Map Source

CRDT Map is a Data.Map indexed by MapField and holding MapEntry.

Maps are specials in a way that they can additionally hold Flags, Registers, and most importantly, other Maps.

Constructors

Map MapContent

Instances

Eq Map
Show Map
Generic Map
NFData Map
Default Map
CRDT Map MapOp
type Rep Map

type MapContent = Map MapField MapEntry Source

data MapField Source

CRDT Map is indexed by MapField, which is a name tagged by a type (there may be different entries with the same name, but different types)

Constructors

MapField MapEntryTag ByteString

Instances

Eq MapField
Ord MapField
Show MapField
Generic MapField
NFData MapField
type Rep MapField

data MapEntry Source

CRDT Map holds values of type MapEntry

Constructors

MapCounter !Counter
MapSet !Set
MapRegister !Register
MapFlag !Flag
MapMap !Map

Instances

Eq MapEntry
Show MapEntry
Generic MapEntry
NFData MapEntry
type Rep MapEntry

Inspection

xlookup :: MapPath -> MapEntryTag -> Map -> Maybe MapEntry Source

Lookup a value of a given MapEntryTag type on a given MapPath inside a map

>>> lookup ("a" -/ "b") MapFlagTag $ { "a"/Map: { "b"/Flag: Flag False } } -- pseudo
Just (MapFlag (Flag False))

Modification

data MapOp Source

map operations It's easier to use mapUpdate:

>>> "x" -/ "y" -/ "z" `mapUpdate` SetAdd "elem"
MapUpdate (MapPath ("x" :| ["y","z"])) (MapCounterOp (CounterInc 1))

Constructors

MapRemove MapField	remove value in map
MapUpdate MapPath MapValueOp	update value on path by operation

Instances

Eq MapOp
Show MapOp
CRDT Map MapOp

newtype MapPath Source

Selector (“xpath”) inside Map

Constructors

MapPath (NonEmpty ByteString)

Instances

Eq MapPath
Show MapPath
IsString MapPath

data MapValueOp Source

Operations on map values

Constructors

MapCounterOp !CounterOp
MapSetOp !SetOp
MapRegisterOp !RegisterOp
MapFlagOp !FlagOp
MapMapOp !MapOp

Instances

Eq MapValueOp
Show MapValueOp

mapUpdate :: IsMapOp o => MapPath -> o -> MapOp infixr 5 Source

(-/) :: ByteString -> MapPath -> MapPath infixr 6 Source

Registers

newtype Register Source

Registers can only be held as a Map element.

Register holds a ByteString.

Constructors

Register ByteString

Instances

Eq Register
Show Register
Generic Register
Monoid Register	Last-wins monoid for `Register`
NFData Register
Semigroup Register
Default Register
type Rep Register

Modification

data RegisterOp Source

Registers can be set to a value

>>> RegisterSet "foo"

Constructors

RegisterSet !ByteString

Instances

Eq RegisterOp
Show RegisterOp

Flags

newtype Flag Source

Flags can only be held as a Map element.

Flag can be set or unset

>>> Flag False

Constructors

Flag Bool

Instances

Eq Flag
Ord Flag
Show Flag
Generic Flag
Monoid Flag	Last-wins monoid for `Flag`
NFData Flag
Semigroup Flag	Last-wins semigroup for `Flag`
Default Flag
type Rep Flag

Modification

data FlagOp Source

Flags can be enabled / disabled

>>> FlagSet True

Constructors

FlagSet !Bool

Instances

Eq FlagOp
Show FlagOp

Misc

data NonEmpty a :: * -> *

Constructors

a :| [a]

Instances

Monad NonEmpty
Functor NonEmpty
MonadFix NonEmpty
Applicative NonEmpty
Foldable NonEmpty
Traversable NonEmpty
Generic1 NonEmpty
MonadZip NonEmpty
IsList (NonEmpty a)
Eq a => Eq (NonEmpty a)
Data a => Data (NonEmpty a)
Ord a => Ord (NonEmpty a)
Read a => Read (NonEmpty a)
Show a => Show (NonEmpty a)
Generic (NonEmpty a)
NFData a => NFData (NonEmpty a)
Hashable a => Hashable (NonEmpty a)
Semigroup (NonEmpty a)
Typeable (* -> *) NonEmpty
type Rep1 NonEmpty = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector Par1) (S1 NoSelector (Rec1 []))))
type Rep (NonEmpty a) = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector (Rec0 a)) (S1 NoSelector (Rec0 [a]))))
type Item (NonEmpty a) = a

mapEntryTag :: MapValueOp -> MapEntryTag Source

setFromSeq :: Seq ByteString -> Set Source

data MapEntryTag Source

Constructors

MapCounterTag
MapSetTag
MapRegisterTag
MapFlagTag
MapMapTag

Instances

Eq MapEntryTag
Ord MapEntryTag
Show MapEntryTag
Generic MapEntryTag
NFData MapEntryTag
type Rep MapEntryTag