RON.Data

Typed and untyped RON tools

Documentation

class (Eq a, Monoid 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 -> StateChunk

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 -> StateChunk

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible ORSetRep

Defined in RON.Data.ORSet

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> ORSetRep

stateToChunk :: ORSetRep -> StateChunk

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible RgaRep

Defined in RON.Data.RGA

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> RgaRep

stateToChunk :: RgaRep -> StateChunk

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

reduceUnappliedPatches :: Unapplied -> Unapplied

Reducible VersionVector

Defined in RON.Data.VersionVector

Methods

reducibleOpType :: UUID

stateFromChunk :: [Op] -> VersionVector

stateToChunk :: VersionVector -> StateChunk

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 a => Replicated (Maybe a)

Defined in RON.Data.Internal

Methods

encoding :: Encoding (Maybe 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 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

Methods

objectOpType :: UUID

UUID of the type

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

Encode data. Write frame and return id.

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

Decode data

Instances

ReplicatedAsObject VersionVector

Defined in RON.Data.VersionVector

Methods

objectOpType :: UUID

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

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

Replicated a => ReplicatedAsObject (ORSet a)

Defined in RON.Data.ORSet

Methods

objectOpType :: UUID

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

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

Replicated a => ReplicatedAsObject (RGA a)

Defined in RON.Data.RGA

Methods

objectOpType :: UUID

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

getObject :: (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 -> [Atom]

Encode data

fromPayload :: MonadE m => [Atom] -> m a

Decode data

Instances

ReplicatedAsPayload Bool

Defined in RON.Data.Internal

Methods

toPayload :: Bool -> [Atom]

fromPayload :: MonadE m => [Atom] -> m Bool

ReplicatedAsPayload Char

Defined in RON.Data.Internal

Methods

toPayload :: Char -> [Atom]

fromPayload :: MonadE m => [Atom] -> m Char

ReplicatedAsPayload Int64

Defined in RON.Data.Internal

Methods

toPayload :: Int64 -> [Atom]

fromPayload :: MonadE m => [Atom] -> m Int64

ReplicatedAsPayload Text

Defined in RON.Data.Internal

Methods

toPayload :: Text -> [Atom]

fromPayload :: MonadE m => [Atom] -> m Text

ReplicatedAsPayload UUID

Defined in RON.Data.Internal

Methods

toPayload :: UUID -> [Atom]

fromPayload :: MonadE m => [Atom] -> m UUID

ReplicatedAsPayload Day

Defined in RON.Data.Time

Methods

toPayload :: Day -> [Atom]

fromPayload :: MonadE m => [Atom] -> m Day

ReplicatedAsPayload a => ReplicatedAsPayload (Maybe a)

Defined in RON.Data.Internal

Methods

toPayload :: Maybe a -> [Atom]

fromPayload :: MonadE m => [Atom] -> m (Maybe a)

fromRon :: (MonadE m, Replicated a, MonadState StateFrame m) => [Atom] -> m a

Decode typed data from a payload. The implementation may use other objects in the frame to resolve references. TODO(2019-06-28, cblp) use ReaderT for symmetry with newRon

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

mkStateChunk :: UUID -> [Op] -> StateChunk

newRon :: (Replicated a, ReplicaClock m, MonadState StateFrame m) => a -> m [Atom]

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.

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

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

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

reduceWireFrame :: WireFrame -> WireFrame

ObjectState monad

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

type MonadObjectState b m = (MonadReader (Object b) m, MonadState StateFrame m)

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

Run ObjectState action

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

Run ObjectState action, starting with an empty frame

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

Run ObjectState action

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

Run ObjectState action, starting with an empty frame

newObjectState :: (ReplicatedAsObject a, ReplicaClock m) => a -> m (ObjectState a)

Create new ObjectState from a value

newObjectStateWith :: Functor m => StateT StateFrame m (Object a) -> m (ObjectState a)

Create new ObjectState with an action

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

Run ObjectState action

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

Run ObjectState action, starting with an empty frame