RON.Data

Typed and untyped RON tools

Documentation

class (Eq a, BoundedSemilattice a) => Reducible a where

Untyped-reducible types. Untyped means if this type is a container then the types of data contained in it is not considered.

Minimal complete definition

reducibleOpType, stateFromChunk, stateToChunk

Methods

reducibleOpType :: UUID

UUID of the type

stateFromChunk :: [Op] -> a

Load a state from a state chunk.

stateToChunk :: a -> [Op]

Store a state to a state chunk

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

Merge a state with patches and raw ops

reduceUnappliedPatches :: Unapplied -> Unapplied

Merge patches and raw ops into bigger patches or throw obsolete ops

Instances

Reducible LwwRep

Defined in RON.Data.LWW

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> LwwRep

stateToChunk :: LwwRep -> [Op]

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible ORSetRep

Defined in RON.Data.ORSet

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> ORSetRep

stateToChunk :: ORSetRep -> [Op]

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible RgaRep

Defined in RON.Data.RGA

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> RgaRep

stateToChunk :: RgaRep -> [Op]

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible VersionVector

Defined in RON.Data.VersionVector

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> VersionVector

stateToChunk :: VersionVector -> [Op]

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

reduceUnappliedPatches :: Unapplied -> Unapplied

class Replicated a where

Base class for typed encoding

Methods

encoding :: Encoding a

Instances SHOULD implement encoding either as objectEncoding or as payloadEncoding

Instances

Replicated Bool

Defined in RON.Data.Internal

Methods

encoding :: Encoding Bool

Replicated Char

Defined in RON.Data.Internal

Methods

encoding :: Encoding Char

Replicated Int64

Defined in RON.Data.Internal

Methods

encoding :: Encoding Int64

Replicated Text

Defined in RON.Data.Internal

Methods

encoding :: Encoding Text

Replicated UUID

Defined in RON.Data.Internal

Methods

encoding :: Encoding UUID

Replicated Day

Defined in RON.Data.Time

Methods

encoding :: Encoding Day

Replicated VersionVector

Defined in RON.Data.VersionVector

Methods

encoding :: Encoding VersionVector

Replicated (ObjectRef a)

Defined in RON.Data.Internal

Methods

encoding :: Encoding (ObjectRef a)

Replicated a => Replicated (ORSet a)

Defined in RON.Data.ORSet

Methods

encoding :: Encoding (ORSet a)

Replicated a => Replicated (RGA a)

Defined in RON.Data.RGA

Methods

encoding :: Encoding (RGA a)

class (Reducible (Rep a), Replicated a) => ReplicatedAsObject a where

Instances of this class are encoded as objects. An enclosing object's payload will be filled with this object's id.

Law: encoding == objectEncoding

Associated Types

type Rep a

Untyped RON-RDT representation

Methods

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

Encode data. Write frame and return id.

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

Decode data

Instances

ReplicatedAsObject VersionVector

Defined in RON.Data.VersionVector

Associated Types

type Rep VersionVector :: Type

Methods

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

readObject :: (MonadE m, MonadObjectState VersionVector m) => m VersionVector

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 => ReplicatedAsObject (RGA a)

Defined in RON.Data.RGA

Associated Types

type Rep (RGA a) :: Type

Methods

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

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

class Replicated a => ReplicatedAsPayload a where

Instances of this class are encoded as payload only.

Law: encoding == payloadEncoding

Methods

toPayload :: a -> Payload

Encode data

fromPayload :: MonadE m => Payload -> m a

Decode data

Instances

ReplicatedAsPayload Bool

Defined in RON.Data.Internal

Methods

toPayload :: Bool -> Payload

fromPayload :: MonadE m => Payload -> m Bool

ReplicatedAsPayload Char

Defined in RON.Data.Internal

Methods

toPayload :: Char -> Payload

fromPayload :: MonadE m => Payload -> m Char

ReplicatedAsPayload Int64

Defined in RON.Data.Internal

Methods

toPayload :: Int64 -> Payload

fromPayload :: MonadE m => Payload -> m Int64

ReplicatedAsPayload Text

Defined in RON.Data.Internal

Methods

toPayload :: Text -> Payload

fromPayload :: MonadE m => Payload -> m Text

ReplicatedAsPayload UUID

Defined in RON.Data.Internal

Methods

toPayload :: UUID -> Payload

fromPayload :: MonadE m => Payload -> m UUID

ReplicatedAsPayload Day

Defined in RON.Data.Time

Methods

toPayload :: Day -> Payload

fromPayload :: MonadE m => Payload -> m Day

ReplicatedAsPayload (ObjectRef a)

Defined in RON.Data.Internal

Methods

toPayload :: ObjectRef a -> Payload

fromPayload :: MonadE m => Payload -> m (ObjectRef a)

fromRon :: (MonadE m, Replicated a, MonadState StateFrame m) => Payload -> m a

Decode typed data from a payload. The implementation may use other objects in the frame to resolve references.

getObjectStateChunk :: forall a m. (MonadE m, MonadObjectState a m) => m (StateChunk (Rep a))

newRon :: (Replicated a, ReplicaClock m, MonadState StateFrame m) => a -> m Payload

Encode typed data to a payload with possible addition objects

objectEncoding :: ReplicatedAsObject a => Encoding a

Standard implementation of Replicated for ReplicatedAsObject types.

payloadEncoding :: ReplicatedAsPayload a => Encoding a

Standard implementation of Replicated for ReplicatedAsPayload types.

rconcat :: forall a m. (MonadE m, MonadState StateFrame m, ReplicatedAsObject a) => NonEmpty UUID -> m a

reduceObject :: MonadE m => ObjectFrame a -> ObjectFrame a -> m (ObjectFrame a)

Reduce object with frame from another version of the same object.

reduceStateFrame :: MonadE m => StateFrame -> StateFrame -> m StateFrame

reduceWireFrame :: WireFrame -> WireFrame

stateFromWireChunk :: forall a m. (MonadE m, Reducible a) => WireStateChunk -> m a

stateToWireChunk :: forall rep. Reducible rep => rep -> WireStateChunk

Object-state monad

type ObjectStateT b m a = ReaderT (ObjectRef b) (StateT StateFrame m) a

type MonadObjectState a m = (MonadReader (ObjectRef a) m, MonadState StateFrame m, Reducible (Rep a))

evalObjectState :: Monad m => ObjectFrame b -> ObjectStateT b m a -> m a

Run ObjectFrame action

evalObjectState_ :: Monad m => StateT StateFrame m a -> m a

Run ObjectFrame action, starting with an empty frame

execObjectState :: Monad m => ObjectFrame b -> ObjectStateT b m a -> m (ObjectFrame b)

Run ObjectFrame action

execObjectState_ :: Monad m => StateT StateFrame m a -> m StateFrame

Run ObjectFrame action, starting with an empty frame

newObjectFrame :: (ReplicatedAsObject a, ReplicaClock m) => a -> m (ObjectFrame a)

Create new ObjectFrame from a value

newObjectFrameWith :: Functor m => StateT StateFrame m (ObjectRef a) -> m (ObjectFrame a)

Create new ObjectFrame with an action

runObjectState :: Functor m => ObjectFrame b -> ObjectStateT b m a -> m (a, ObjectFrame b)

Run ObjectFrame action

runObjectState_ :: StateT StateFrame m a -> m (a, StateFrame)

Run ObjectFrame action, starting with an empty frame