Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Util.NormalForm.StrictTVar

2 types
20 values

Packageouroboros-consensus-4.2.1.0
Exports22
LicenceApache-2.0
SourceChecked.hs

valuenoThunksInvariant :: NoThunks a => a -> Maybe String

valuenewTVar

:: (HasCallStack, MonadSTM m, NoThunks a)
=> a
-> STM m (StrictTVar m a)

valuenewTVarIO

:: (HasCallStack, MonadSTM m, NoThunks a)
=> a
-> m (StrictTVar m a)

valuenewTVarWithInvariant

:: (HasCallStack, MonadSTM m, NoThunks a)
=> a -> Maybe String
-> a
-> STM m (StrictTVar m a)

valuenewTVarWithInvariantIO

:: (HasCallStack, MonadSTM m, NoThunks a)
=> a -> Maybe String
-> a
-> m (StrictTVar m a)

valueuncheckedNewTVarM :: MonadSTM m => a -> m (StrictTVar m a)

valuecastStrictTVar

:: LazyTVar m ~ LazyTVar n
=> StrictTVar m a
-> StrictTVar n a

valuefromLazyTVar :: LazyTVar m a -> StrictTVar m a

Create a StrictMVar from a LazyMVar

It is not guaranteed that the LazyTVar contains a value that is in WHNF, so there is no guarantee that the resulting StrictTVar contains a value that is in WHNF. This should be used with caution.

The resulting StrictTVar has a trivial invariant.

valuelabelTVar :: MonadLabelledSTM m => StrictTVar m a -> String -> STM m ()

valuelabelTVarIO :: MonadLabelledSTM m => StrictTVar m a -> String -> m ()

valuemodifyTVar :: MonadSTM m => StrictTVar m a -> (a -> a) -> STM m ()

valuereadTVar :: MonadSTM m => StrictTVar m a -> STM m a

valuereadTVarIO :: MonadSTM m => StrictTVar m a -> m a

valuestateTVar :: MonadSTM m => StrictTVar m s -> (s -> (a, s)) -> STM m a

valueswapTVar :: MonadSTM m => StrictTVar m a -> a -> STM m a

valuetoLazyTVar :: StrictTVar m a -> LazyTVar m a

Get the underlying TVar

Since we obviously cannot guarantee that updates to this LazyTVar will be strict, this should be used with caution.

Similarly, we can not guarantee that updates to this LazyTVar do not break the original invariant that the StrictTVar held.

valuetraceTVar

:: MonadTraceSTM m
=> proxy m
-> StrictTVar m a
-> Maybe a -> a -> InspectMonadSTM m TraceValue
-> STM m ()

valuetraceTVarIO

:: MonadTraceSTM m
=> StrictTVar m a
-> Maybe a -> a -> InspectMonadSTM m TraceValue
-> m ()

valueunsafeToUncheckedStrictTVar :: StrictTVar m a -> StrictTVar m a

Create an unchecked reference to the given checked StrictTVar.

Note that the invariant is only guaranteed when modifying the checked TVar. Any modification to the unchecked reference might break the invariants.

valuewriteTVar :: (MonadSTM m, HasCallStack) => StrictTVar m a -> a -> STM m ()

typetype LazyTVar (m :: Type -> Type) = LazyTVar m

newtypenewtype StrictTVar (m :: Type -> Type) a

Instances1NoThunks

NoThunks (StrictTVar IO a) => NoThunks (StrictTVar IO a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.NormalForm.StrictTVar · orphan

Orphan instances

1 instance

NoThunks (StrictTVar IO a) => NoThunks (StrictTVar IO a)