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 Source
Show DataType Source
Generic DataType Source
NFData DataType Source
type Rep DataType Source

Counters

newtype Counter Source

CRDT Counter hold a integer Count

>>> Counter 42

Constructors

Counter Count

Instances

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

type Count = Int64 Source

Modification

data CounterOp Source

Counters can be incremented/decremented

>>> CounterInc 1

Constructors

CounterInc !Count

Instances

Eq CounterOp Source
Show CounterOp Source
Monoid CounterOp Source
CRDT Counter CounterOp Source

Sets

newtype Set Source

CRDT Set is a Data.Set

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

Constructors

Set (Set ByteString)

Instances

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

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 Source
Show SetOp Source
CRDT Set SetOp Source

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 Source
Show Map Source
Generic Map Source
NFData Map Source
Default Map Source
CRDT Map MapOp Source
type Rep Map Source

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 Source
Ord MapField Source
Show MapField Source
Generic MapField Source
NFData MapField Source
type Rep MapField Source

data MapEntry Source

CRDT Map holds values of type MapEntry

Constructors

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

Instances

Eq MapEntry Source
Show MapEntry Source
Generic MapEntry Source
NFData MapEntry Source
type Rep MapEntry Source

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 Source
Show MapOp Source
CRDT Map MapOp Source

newtype MapPath Source

Selector (“xpath”) inside Map

Constructors

MapPath (NonEmpty ByteString)

Instances

Eq MapPath Source
Show MapPath Source
IsString MapPath Source

data MapValueOp Source

Operations on map values

Constructors

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

Instances

Eq MapValueOp Source
Show MapValueOp Source

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 Source
Show Register Source
Generic Register Source
Monoid Register Source	Last-wins monoid for `Register`
NFData Register Source
Semigroup Register Source
Default Register Source
type Rep Register Source

Modification

data RegisterOp Source

Registers can be set to a value

>>> RegisterSet "foo"

Constructors

RegisterSet !ByteString

Instances

Eq RegisterOp Source
Show RegisterOp Source

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 Source
Ord Flag Source
Show Flag Source
Generic Flag Source
Monoid Flag Source	Last-wins monoid for `Flag`
NFData Flag Source
Semigroup Flag Source	Last-wins semigroup for `Flag`
Default Flag Source
type Rep Flag Source

Modification

data FlagOp Source

Flags can be enabled / disabled

>>> FlagSet True

Constructors

FlagSet !Bool

Instances

Eq FlagOp Source
Show FlagOp Source

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)
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 Source
Ord MapEntryTag Source
Show MapEntryTag Source
Generic MapEntryTag Source
NFData MapEntryTag Source
type Rep MapEntryTag Source