Observe.Event.Render.InMemory

Documentation

listInMemoryBackend

Arguments

:: (MemoryEvent IO (ListAppendVector IO) UTCTime s -> IO ())

Notify of an Event with no parents or causes

-> EventBackend IO (MemoryEvent IO (ListAppendVector IO) UTCTime s) s

An EventBackend whose Events are essentially plain Haskell values.

The reference of an Event from this EventBackend will be a MemoryEvent, which can be examined to extract information about the Event.

timelessListInMemoryBackend

Arguments

:: PrimMonad m

=> (MemoryEvent m (ListAppendVector m) () s -> m ())

Notify of an Event with no parents or causes

-> EventBackend m (MemoryEvent m (ListAppendVector m) () s) s

An EventBackend whose Events are essentially plain Haskell values.

The reference of an Event from this EventBackend will be a MemoryEvent, which can be examined to extract information about the Event.

inMemoryBackend

Arguments

:: Monad m

=> InMemoryEffects m appvec ts

-> (MemoryEvent m appvec ts s -> m ())

Notify of an Event with no parents or causes

-> EventBackend m (MemoryEvent m appvec ts s) s

An EventBackend whose Events are essentially plain Haskell values.

The reference of an Event from this EventBackend will be a MemoryEvent, which can be examined to extract information about the Event.

appvec

An append-only vector type, see AppendVectorEffects

ts

A timestamp, see TimestampEffects

MemoryEvent

data MemoryEvent m appvec ts s

An plain data type representing an Event

appvec

An append-only vector type, see AppendVectorEffects

ts

A timestamp, see TimestampEffects

Constructors

forall f. MemoryEvent

Fields

• initArgs :: !(NewEventArgs (MemoryEvent m appvec ts s) s f)

  The arguments the Event was initialized with

• start :: !ts

  The start time of the Event

• dynamicValues :: !(Maybe (appvec (TimedEventAction ts f)))

  Event information added during the event's lifecycle

  Nothing if this was the result of emitImmediateEvent and thus had no lifecycle

• childEvents :: !(appvec (MemoryEvent m appvec ts s))

  Direct children of this event

• causedEvents :: !(appvec (MemoryEvent m appvec ts s))

  Events directly caused by this event

data TimedEventAction ts f

An action that occurred during an Event at some time.

ts

A timestamp, see TimestampEffects

Constructors

TimedEventAction

Fields

• eventTime :: !ts

  When the event occurred

• act :: !(EventAction f)

  The action that occurred

data EventAction f

An action on an Event

Constructors

AddField !f

A field was added with addField

Finalize !(Maybe SomeException)

The Event was finalized with finalize

Effects

InMemoryEffects

data InMemoryEffects m appvec ts

Monadic effects needed to construct an inMemoryBackend

appvec

An append-only vector type, see AppendVectorEffects

ts

A timestamp, see TimestampEffects

Constructors

InMemoryEffects

Fields

• appendVectorEffects :: !(AppendVectorEffects m appvec)

  Manipulate append-only vectors

• timestampEffects :: !(TimestampEffects m ts)

  Get timestamps

hoistInMemoryEffects :: (forall x. m x -> n x) -> InMemoryEffects m appvec ts -> InMemoryEffects n appvec ts

Hoist InMemoryEffects along a given natural transformation into a new monad

listInMemoryEffects :: InMemoryEffects IO (ListAppendVector IO) UTCTime

InMemoryEffects based on listAppendVectorEffects and ioTimestampEffects.

timelessListInMemoryEffects :: PrimMonad m => InMemoryEffects m (ListAppendVector m) ()

InMemoryEffects based on listAppendVectorEffects with meaningless timestamps.

AppendVectorEffects

data AppendVectorEffects m appvec

Monadic effects to manipulate append-only vectors.

Constructors

AppendVectorEffects

Fields

• newVector :: !(forall a. m (appvec a))

  Create a new vector

• appendVector :: !(forall a. appvec a -> a -> m ())

  Append a value to a vector

hoistAppendVectorEffects :: (forall x. m x -> n x) -> AppendVectorEffects m appvec -> AppendVectorEffects n appvec

Hoist AppendVectorEffects along a given natural transformation into a new monad

newtype ListAppendVector m a

An append-only vector in some PrimMonad based on lists.

Constructors

ListAppendVector (MutVar (PrimState m) [a])

listAppendVectorEffects :: PrimMonad m => AppendVectorEffects m (ListAppendVector m)

AppendVectorEffects in some PrimMonad based on lists.

TimestampEffects

newtype TimestampEffects m ts

Monadic effects to manage timestamps.

Constructors

TimestampEffects

Fields

• getTimestamp :: m ts

hoistTimestampEffects :: (forall x. m x -> n x) -> TimestampEffects m ts -> TimestampEffects n ts

Hoist TimestampEffects along a given natural transformation into a new monad

dummyTimestampEffects :: Applicative m => TimestampEffects m ()

TimestampEffects with meaningless timestamps.

ioTimestampEffects :: TimestampEffects IO UTCTime

TimestampEffects using the system clock