Safe Haskell	None
Language	GHC2021

Navi.Env.Core

Contents

HasX-style Typeclasses
- Deriving
Concrete Env

Description

This module provides the core Env type for Navi.

Synopsis

class HasEvents env where
- getEvents :: env -> NonEmpty AnyEvent
class HasLogEnv env where
- getLogEnv :: env -> Maybe LogEnv
class HasNoteQueue env where
- getNoteQueue :: env -> TBQueue NaviNote
sendNoteQueue :: (HasCallStack, HasNoteQueue env, MonadReader env m, MonadSTM m) => NaviNote -> m ()
newtype TopField a = MkTopField a
newtype CoreEnvField a = MkCoreEnvField a
data Env = MkEnv {
- events :: NonEmpty AnyEvent
- logEnv :: Maybe LogEnv
- noteQueue :: TBQueue NaviNote
- notifySystem :: NoteSystem 'ConfigPhaseEnv
}

HasX-style Typeclasses

class HasEvents env where Source #

Retrieves the events.

Methods

getEvents :: env -> NonEmpty AnyEvent Source #

Instances

Instances details

HasEvents Env Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: Env -> NonEmpty AnyEvent Source #
(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasEvents (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: CoreEnvField a -> NonEmpty AnyEvent Source #
(Is k A_Getter, LabelOptic' "events" k a (NonEmpty AnyEvent)) => HasEvents (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: TopField a -> NonEmpty AnyEvent Source #

class HasLogEnv env where Source #

Retrieves the log environment.

Methods

getLogEnv :: env -> Maybe LogEnv Source #

Instances

Instances details

HasLogEnv Env Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: Env -> Maybe LogEnv Source #
(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasLogEnv (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: CoreEnvField a -> Maybe LogEnv Source #
(Is k A_Getter, LabelOptic' "logEnv" k a (Maybe LogEnv)) => HasLogEnv (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: TopField a -> Maybe LogEnv Source #

class HasNoteQueue env where Source #

Retrieves the note queue.

Methods

getNoteQueue :: env -> TBQueue NaviNote Source #

Instances

Instances details

HasNoteQueue Env Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: Env -> TBQueue NaviNote Source #
(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasNoteQueue (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: CoreEnvField a -> TBQueue NaviNote Source #
(Is k A_Getter, LabelOptic' "noteQueue" k a (TBQueue NaviNote)) => HasNoteQueue (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: TopField a -> TBQueue NaviNote Source #

sendNoteQueue :: (HasCallStack, HasNoteQueue env, MonadReader env m, MonadSTM m) => NaviNote -> m () Source #

Convenience function for retrieving a TBQueue NaviNote from the env and sending the note.

Deriving

newtype TopField a Source #

Used for deriving instances from the top level field name e.g. 'events :: NonEmpty AnyEvent'.

Constructors

MkTopField a

Instances

Instances details

(Is k A_Getter, LabelOptic' "events" k a (NonEmpty AnyEvent)) => HasEvents (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: TopField a -> NonEmpty AnyEvent Source #
(Is k A_Getter, LabelOptic' "logEnv" k a (Maybe LogEnv)) => HasLogEnv (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: TopField a -> Maybe LogEnv Source #
(Is k A_Getter, LabelOptic' "noteQueue" k a (TBQueue NaviNote)) => HasNoteQueue (TopField a) Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: TopField a -> TBQueue NaviNote Source #

newtype CoreEnvField a Source #

Used for deriving instances for types with a field 'coreEnv :: Env'.

Constructors

MkCoreEnvField a

Instances

Instances details

(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasEvents (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: CoreEnvField a -> NonEmpty AnyEvent Source #
(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasLogEnv (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: CoreEnvField a -> Maybe LogEnv Source #
(Is k A_Getter, LabelOptic' "coreEnv" k a Env) => HasNoteQueue (CoreEnvField a) Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: CoreEnvField a -> TBQueue NaviNote Source #

Concrete Env

data Env Source #

Env holds all of our environment data that is used while running navi.

Constructors

MkEnv
Fields events :: NonEmpty AnyEvent logEnv :: Maybe LogEnv noteQueue :: TBQueue NaviNote notifySystem :: NoteSystem 'ConfigPhaseEnv

Instances

Instances details

HasEvents Env Source #
Instance details Defined in Navi.Env.Core Methods getEvents :: Env -> NonEmpty AnyEvent Source #
HasLogEnv Env Source #
Instance details Defined in Navi.Env.Core Methods getLogEnv :: Env -> Maybe LogEnv Source #
HasNoteQueue Env Source #
Instance details Defined in Navi.Env.Core Methods getNoteQueue :: Env -> TBQueue NaviNote Source #
(k ~ A_Lens, a ~ NonEmpty AnyEvent, b ~ NonEmpty AnyEvent) => LabelOptic "events" k Env Env a b Source #
Instance details Defined in Navi.Env.Core Methods labelOptic :: Optic k NoIx Env Env a b Source #
(k ~ A_Lens, a ~ Maybe LogEnv, b ~ Maybe LogEnv) => LabelOptic "logEnv" k Env Env a b Source #
Instance details Defined in Navi.Env.Core Methods labelOptic :: Optic k NoIx Env Env a b Source #
(k ~ A_Lens, x ~ Namespace, y ~ Namespace) => LabelOptic "namespace" k Env Env x y Source #
Instance details Defined in Navi.Env.Core Methods labelOptic :: Optic k NoIx Env Env x y Source #
(k ~ A_Lens, a ~ TBQueue NaviNote, b ~ TBQueue NaviNote) => LabelOptic "noteQueue" k Env Env a b Source #
Instance details Defined in Navi.Env.Core Methods labelOptic :: Optic k NoIx Env Env a b Source #
(k ~ A_Lens, a ~ NoteSystem 'ConfigPhaseEnv, b ~ NoteSystem 'ConfigPhaseEnv) => LabelOptic "notifySystem" k Env Env a b Source #
Instance details Defined in Navi.Env.Core Methods labelOptic :: Optic k NoIx Env Env a b Source #
(MonadSTM m, MonadTime m, MonadThread m) => MonadLogger (NaviT Env m) Source #
Instance details Defined in Navi.NaviT Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> NaviT Env m () Source #
(MonadDBus m, MonadSTM m, MonadTime m, MonadThread m, MonadTypedProcess m) => MonadNotify (NaviT Env m) Source #
Instance details Defined in Navi.NaviT Methods sendNote :: NaviNote -> NaviT Env m () Source #