shrun

Safe Haskell	None
Language	GHC2021

Shrun.Logging.MonadRegionLogger

Description

Provides functionality for logging to a specific region (i.e. for concurrent console logging).

Synopsis

class (Eq (Region m), Monad m) => MonadRegionLogger (m :: Type -> Type) where
- type Region (m :: Type -> Type)
- logGlobal :: Text -> m ()
- logRegion :: LogMode -> Region m -> Text -> m ()
- withRegion :: HasCallStack => RegionLayout -> (Region m -> m a) -> m a
- displayRegions :: HasCallStack => m a -> m a
- regionList :: m (TMVar [Region m])
restoreTimerRegion :: (MonadAtomic m, MonadIORef m, MonadRegionLogger m) => IORef (Maybe (Region m)) -> m ()

Documentation

class (Eq (Region m), Monad m) => MonadRegionLogger (m :: Type -> Type) where Source #

MonadRegionLogger is a simple typeclass for abstracting logging functions.

Associated Types

type Region (m :: Type -> Type) Source #

The type of the region. This will be ConsoleRegion for production code and () for tests.

Methods

logGlobal :: Text -> m () Source #

Pushes a log to the "global" region.

logRegion :: LogMode -> Region m -> Text -> m () Source #

Pushes a log to the region.

withRegion :: HasCallStack => RegionLayout -> (Region m -> m a) -> m a Source #

Runs an m a with a region.

displayRegions :: HasCallStack => m a -> m a Source #

Displays the regions. This should wrap whatever top-level logic needs regions.

regionList :: m (TMVar [Region m]) Source #

Retrieve all regions.

Instances

Instances details

MonadRegionLogger IO Source #

Instance details

Defined in Shrun.Logging.MonadRegionLogger

Associated Types

type Region IO
Instance details Defined in Shrun.Logging.MonadRegionLogger type Region IO = ConsoleRegion

Methods

logGlobal :: Text -> IO () Source #

logRegion :: LogMode -> Region IO -> Text -> IO () Source #

withRegion :: HasCallStack => RegionLayout -> (Region IO -> IO a) -> IO a Source #

displayRegions :: HasCallStack => IO a -> IO a Source #

regionList :: IO (TMVar [Region IO]) Source #

MonadRegionLogger m => MonadRegionLogger (ShellT (Env notifyEnv r) m) Source #

Instance details

Defined in Shrun.ShellT

Associated Types

type Region (ShellT (Env notifyEnv r) m)
Instance details Defined in Shrun.ShellT type Region (ShellT (Env notifyEnv r) m) = Region (ReaderT (Env notifyEnv r) m)

Methods

logGlobal :: Text -> ShellT (Env notifyEnv r) m () Source #

logRegion :: LogMode -> Region (ShellT (Env notifyEnv r) m) -> Text -> ShellT (Env notifyEnv r) m () Source #

withRegion :: HasCallStack => RegionLayout -> (Region (ShellT (Env notifyEnv r) m) -> ShellT (Env notifyEnv r) m a) -> ShellT (Env notifyEnv r) m a Source #

displayRegions :: HasCallStack => ShellT (Env notifyEnv r) m a -> ShellT (Env notifyEnv r) m a Source #

regionList :: ShellT (Env notifyEnv r) m (TMVar [Region (ShellT (Env notifyEnv r) m)]) Source #

MonadRegionLogger m => MonadRegionLogger (ReaderT env m) Source #

Instance details

Defined in Shrun.Logging.MonadRegionLogger

Associated Types

type Region (ReaderT env m)
Instance details Defined in Shrun.Logging.MonadRegionLogger type Region (ReaderT env m) = Region m

Methods

logGlobal :: Text -> ReaderT env m () Source #

logRegion :: LogMode -> Region (ReaderT env m) -> Text -> ReaderT env m () Source #

withRegion :: HasCallStack => RegionLayout -> (Region (ReaderT env m) -> ReaderT env m a) -> ReaderT env m a Source #

displayRegions :: HasCallStack => ReaderT env m a -> ReaderT env m a Source #

regionList :: ReaderT env m (TMVar [Region (ReaderT env m)]) Source #

restoreTimerRegion :: (MonadAtomic m, MonadIORef m, MonadRegionLogger m) => IORef (Maybe (Region m)) -> m () Source #

Moves the timer region to the bottom of all active regions.

See NOTE: [Restore Timer Region].