Data.CRDT.EventFold.Monad

Documentation

class MonadUpdateEF o p e (m :: Type -> Type) | m -> o p e where

The interface for monadically updating an EventFold, where the monadic context is intended to manage:

• The local participant.
• The current state of the EventFold.
• The accumulated consistent outputs.
• Whether the EventFold needs to be propagated to other participants.

Methods

event :: e -> m (Output e, EventId p)

Apply an event. See event.

fullMerge :: EventFold o p e -> m (Either (MergeError o p e) ())

Perform a full merge. See fullMerge.

diffMerge :: Diff o p e -> m (Either (MergeError o p e) ())

Perform a diff merge. See diffMerge.

participate :: p -> m (EventId p)

Allow a new participant to join in the cluster. See participate.

disassociate :: p -> m (EventId p)

Remove a peer from participation. See disassociate.

getResult :: m (UpdateResult o p e)

Get the outstanding update results.

Instances

(Eq (Output e), Eq e, Eq o, Event p e, Monad m, Ord p) => MonadUpdateEF o p e (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

event :: e -> EventFoldT o p e m (Output e, EventId p)

fullMerge :: EventFold o p e -> EventFoldT o p e m (Either (MergeError o p e) ())

diffMerge :: Diff o p e -> EventFoldT o p e m (Either (MergeError o p e) ())

participate :: p -> EventFoldT o p e m (EventId p)

disassociate :: p -> EventFoldT o p e m (EventId p)

getResult :: EventFoldT o p e m (UpdateResult o p e)

class Monad m => MonadInspectEF o p e (m :: Type -> Type) | m -> o p e where

Interface for inspecting an Eventfold contained within the monadic context.

Minimal complete definition

Nothing

Methods

efAsks :: (EventFold o p e -> a) -> m a

efAsk :: m (EventFold o p e)

Instances

Monad m => MonadInspectEF o p e (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

efAsks :: (EventFold o p e -> a) -> EventFoldT o p e m a

efAsk :: EventFoldT o p e m (EventFold o p e)

data EventFoldT o p e (m :: Type -> Type) a

A transformer providing MonadUpdateEF and MonadInspectEF.

Instances

Monad m => MonadInspectEF o p e (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

efAsks :: (EventFold o p e -> a) -> EventFoldT o p e m a

efAsk :: EventFoldT o p e m (EventFold o p e)

(Eq (Output e), Eq e, Eq o, Event p e, Monad m, Ord p) => MonadUpdateEF o p e (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

event :: e -> EventFoldT o p e m (Output e, EventId p)

fullMerge :: EventFold o p e -> EventFoldT o p e m (Either (MergeError o p e) ())

diffMerge :: Diff o p e -> EventFoldT o p e m (Either (MergeError o p e) ())

participate :: p -> EventFoldT o p e m (EventId p)

disassociate :: p -> EventFoldT o p e m (EventId p)

getResult :: EventFoldT o p e m (UpdateResult o p e)

MonadTrans (EventFoldT o p e)

Defined in Data.CRDT.EventFold.Monad

Methods

lift :: Monad m => m a -> EventFoldT o p e m a

MonadIO m => MonadIO (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

liftIO :: IO a -> EventFoldT o p e m a

Monad m => Applicative (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

pure :: a -> EventFoldT o p e m a

(<*>) :: EventFoldT o p e m (a -> b) -> EventFoldT o p e m a -> EventFoldT o p e m b

liftA2 :: (a -> b -> c) -> EventFoldT o p e m a -> EventFoldT o p e m b -> EventFoldT o p e m c

(*>) :: EventFoldT o p e m a -> EventFoldT o p e m b -> EventFoldT o p e m b

(<*) :: EventFoldT o p e m a -> EventFoldT o p e m b -> EventFoldT o p e m a

Functor m => Functor (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

fmap :: (a -> b) -> EventFoldT o p e m a -> EventFoldT o p e m b

(<$) :: a -> EventFoldT o p e m b -> EventFoldT o p e m a

Monad m => Monad (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

(>>=) :: EventFoldT o p e m a -> (a -> EventFoldT o p e m b) -> EventFoldT o p e m b

(>>) :: EventFoldT o p e m a -> EventFoldT o p e m b -> EventFoldT o p e m b

return :: a -> EventFoldT o p e m a

MonadThrow m => MonadThrow (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

throwM :: (HasCallStack, Exception e0) => e0 -> EventFoldT o p e m a

MonadLogger m => MonadLogger (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> EventFoldT o p e m ()

MonadLoggerIO m => MonadLoggerIO (EventFoldT o p e m)

Defined in Data.CRDT.EventFold.Monad

Methods

askLoggerIO :: EventFoldT o p e m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())

runEventFoldT

Arguments

:: Ord p

=> p

The local participant.

-> EventFold o p e

Initial event fold value.

-> EventFoldT o p e m a

The action to run.

-> m (a, UpdateResult o p e)

Returns the result of the action, plus all the accumulated UpdateResults, which contain the new EventFold value, all of the consistent outputs, and a flag indicating whether the new EventFold value should be propagated to the other participants.