Safe Haskell	Safe-Inferred
Language	GHC2021

Polysemy.Conc.Effect.SyncRead

Description

The effect SyncRead is equivalent to Sync without the write actions.

Synopsis

data SyncRead (d :: Type) :: Effect where
- Block :: SyncRead d m d
- Wait :: TimeUnit u => u -> SyncRead d m (Maybe d)
- Try :: SyncRead d m (Maybe d)
- Empty :: SyncRead d m Bool
empty :: forall d r. Member (SyncRead d) r => Sem r Bool
try :: forall d r. Member (SyncRead d) r => Sem r (Maybe d)
wait :: forall d r u. (Member (SyncRead d) r, TimeUnit u) => u -> Sem r (Maybe d)
block :: forall d r. Member (SyncRead d) r => Sem r d

Documentation

An interface to a shared variable (MVar) that can only be read.

Constructors

Block :: SyncRead d m d	Read the variable, waiting until a value is available.
Wait :: TimeUnit u => u -> SyncRead d m (Maybe d)	Read the variable, waiting until a value is available or the timeout has expired.
Try :: SyncRead d m (Maybe d)	Read the variable, returning `Nothing` immmediately if no value was available.
Empty :: SyncRead d m Bool	Indicate whether the variable is empty.

Indicate whether the variable is empty.

try :: forall d r. Member (SyncRead d) r => Sem r (Maybe d) Source #

Read the variable, returning Nothing immmediately if no value was available.

wait :: forall d r u. (Member (SyncRead d) r, TimeUnit u) => u -> Sem r (Maybe d) Source #

Read the variable, waiting until a value is available or the timeout has expired.

block :: forall d r. Member (SyncRead d) r => Sem r d Source #

Read the variable, waiting until a value is available.