RON.Data.ORSet

Observed-Remove Set (OR-Set)

Documentation

newtype ORSet a

Type-directing wrapper for typed OR-Set. Eq instance is purely technical, it doesn't use Ord, nor Hashable, so its result may be confusing.

Constructors

ORSet [a]

Instances

Eq a => Eq (ORSet a)

Defined in RON.Data.ORSet

Methods

(==) :: ORSet a -> ORSet a -> Bool

(/=) :: ORSet a -> ORSet a -> Bool

Show a => Show (ORSet a)

Defined in RON.Data.ORSet

Methods

showsPrec :: Int -> ORSet a -> ShowS

show :: ORSet a -> String

showList :: [ORSet a] -> ShowS

Replicated a => ReplicatedAsObject (ORSet a)

Defined in RON.Data.ORSet

Associated Types

type Rep (ORSet a) :: Type

Methods

newObject :: (ReplicaClock m, MonadState StateFrame m) => ORSet a -> m (ObjectRef (ORSet a))

readObject :: (MonadE m, MonadObjectState (ORSet a) m) => m (ORSet a)

Replicated a => Replicated (ORSet a)

Defined in RON.Data.ORSet

Methods

encoding :: Encoding (ORSet a)

type Rep (ORSet a)

Defined in RON.Data.ORSet

type Rep (ORSet a) = ORSetRep

newtype ORSetItem a

Reference to an item inside an ORSet.

Constructors

ORSetItem UUID

Instances

Show (ORSetItem a)

Defined in RON.Data.ORSet

Methods

showsPrec :: Int -> ORSetItem a -> ShowS

show :: ORSetItem a -> String

showList :: [ORSetItem a] -> ShowS

type ORSetMap k v = ORSet (k, v)

newtype ORSetRep

Untyped OR-Set. Implementation: a map from the itemKey to the original op. Each time a value is added, a new item=op is created. Deletion of a value replaces all its known items with tombstone ops.

Constructors

ORSetRep (Map UUID Op)

Instances

Eq ORSetRep

Defined in RON.Data.ORSet

Methods

(==) :: ORSetRep -> ORSetRep -> Bool

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

Show ORSetRep

Defined in RON.Data.ORSet

Methods

showsPrec :: Int -> ORSetRep -> ShowS

show :: ORSetRep -> String

showList :: [ORSetRep] -> ShowS

Semigroup ORSetRep

Defined in RON.Data.ORSet

Methods

(<>) :: ORSetRep -> ORSetRep -> ORSetRep

sconcat :: NonEmpty ORSetRep -> ORSetRep

stimes :: Integral b => b -> ORSetRep -> ORSetRep

Monoid ORSetRep

Defined in RON.Data.ORSet

Methods

mempty :: ORSetRep

mappend :: ORSetRep -> ORSetRep -> ORSetRep

mconcat :: [ORSetRep] -> ORSetRep

Semilattice ORSetRep

Laws: 1. Idempotent because unionWith is idempotent. 2. Commutative because preferTombstone is commutative.

Defined in RON.Data.ORSet

Reducible ORSetRep

Defined in RON.Data.ORSet

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> ORSetRep

stateToChunk :: ORSetRep -> [Op]

applyPatches :: ORSetRep -> Unapplied -> (ORSetRep, Unapplied)

reduceUnappliedPatches :: Unapplied -> Unapplied

addRef :: (ReplicaClock m, MonadE m, MonadObjectState (ORSet a) m) => ObjectRef a -> m ()

addValue :: (Replicated a, ReplicaClock m, MonadE m, MonadObjectState (ORSet a) m) => a -> m ()

Encode a value and add a it to the OR-Set

findAnyAlive :: (MonadE m, MonadObjectState (ORSet item) m) => m (Maybe (ORSetItem item))

Find any alive item. If no alive item found, return Nothing.

findAnyAlive' :: (MonadE m, MonadObjectState (ORSet item) m) => m (ORSetItem item)

Find any alive item. If no alive item found, report an error.

removeObjectIf :: (MonadE m, ReplicaClock m, MonadObjectState (ORSet a) m) => ObjectStateT a m Bool -> m ()

removeRef :: (MonadE m, ReplicaClock m, MonadObjectState (ORSet a) m) => ObjectRef a -> m ()

Remove an object reference from the OR-Set

removeValue :: (ReplicatedAsPayload a, MonadE m, ReplicaClock m, MonadObjectState (ORSet a) m) => a -> m ()

Remove an atomic value from the OR-Set

zoomItem :: MonadE m => ORSetItem item -> ObjectStateT item m a -> ObjectStateT (ORSet item) m a

Go from modification of the whole set to the modification of an item object.

struct_set

addFieldValue

Arguments

:: (Replicated a, ReplicaClock m, MonadE m, MonadObjectState struct m)

=> UUID

Field name

-> a

Value

-> m ()

assignField

Arguments

:: (Replicated a, ReplicaClock m, MonadE m, MonadObjectState struct m)

=> UUID

Field name

-> Maybe a

Value

-> m ()

Assign a value to a field, deleting all previous (observed) values. Assignment of Nothing just deletes all values.

getFieldObject

Arguments

:: (MonadE m, MonadObjectState struct m, ReplicatedAsObject a)

=> UUID

Field name

-> m (Maybe (ObjectRef a))

Find object field, merge all versions, return Nothing if no versions

newStruct :: (MonadState StateFrame m, ReplicaClock m) => [(UUID, Instance Replicated)] -> m UUID

Create an ORSet object from a list of named fields.

removeFieldValue

Arguments

:: (MonadE m, MonadObjectState struct m, ReplicaClock m, ReplicatedAsPayload a)

=> UUID

Field name

-> a

Value

-> m ()

Remove from a field all values that equal to the specified value.

removeFieldValueIf

Arguments

:: (MonadE m, MonadObjectState struct m, ReplicaClock m, ReplicatedAsPayload a)

=> UUID

Field name

-> (a -> m Bool)

-> m ()

Remove from a field all values that obey the predicate.

viewField

Arguments

:: (MonadE m, MonadState StateFrame m, ReplicatedAsObject a)

=> UUID

Field name

-> StateChunk ORSetRep

ORSet object chunk

-> m (Maybe a)

Decode field value, merge all versions, return Nothing if no versions

viewFieldLWW

Arguments

:: (MonadE m, MonadState StateFrame m, Replicated a)

=> UUID

Field name

-> StateChunk ORSetRep

ORSet object chunk

-> m (Maybe a)

Decode field value, keep last version only

viewFieldMax

Arguments

:: (MonadE m, Ord a, ReplicatedAsPayload a)

=> UUID

Field name

-> StateChunk ORSetRep

ORSet object chunk

-> m (Maybe a)

Decode field value, keep max value only, only for Integer and Float

viewFieldMin

Arguments

:: (MonadE m, Ord a, ReplicatedAsPayload a)

=> UUID

Field name

-> StateChunk ORSetRep

ORSet object chunk

-> m (Maybe a)

Decode field value, keep min value only, only for Integer and Float

viewFieldSet

Arguments

:: (MonadE m, MonadState StateFrame m, Replicated a)

=> UUID

Field name

-> StateChunk ORSetRep

ORSet object chunk

-> m [a]

Decode field value, keep all versions

zoomFieldObject

Arguments

:: (MonadE m, ReplicaClock m, ReplicatedAsObject field, ReplicatedAsObject struct)

=> UUID

Field name

-> ObjectStateT field m a

Inner object modifier

-> ObjectStateT struct m a

Pseudo-lens to an object inside a specified field