Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.Notify

Contents

NotifyInit
NotifyActive
Notify

Synopsis

data NotifyActionsInit (p :: ConfigPhase) = MkNotifyActionsInit {
- complete :: NotifyActionCompleteF p
- start :: SwitchF p NotifyActionStartSwitch
}
data NotifyActionsActive
_NotifyActionsActiveCompleteAny :: AffineFold NotifyActionsActive NotifyActionComplete
_NotifyActionsActiveStartAny :: AffineFold NotifyActionsActive ()
data NotifyP (p :: ConfigPhase) r = MkNotifyP {
- actions :: NotifyActionsF p
- system :: NotifySystemF p r
- timeout :: ConfigPhaseF p NotifyTimeout
}
type NotifyArgs = NotifyP 'ConfigPhaseArgs
type NotifyToml = NotifyP 'ConfigPhaseToml
type NotifyMerged = NotifyP 'ConfigPhaseMerged
type NotificationEnv = NotifyP 'ConfigPhaseEnv
mergeNotifications :: NotifyArgs r -> Maybe (NotifyToml r) -> Maybe (NotifyMerged r)
toEnv :: (HasCallStack, MonadNotify m, MonadThrow m, NotifyEnvF m ~ r) => NotifyMerged r -> m (NotifyP 'ConfigPhaseEnv r)

NotifyInit

data NotifyActionsInit (p :: ConfigPhase) Source #

Initial notify action config.

Constructors

MkNotifyActionsInit
Fields complete :: NotifyActionCompleteF p start :: SwitchF p NotifyActionStartSwitch

Instances

Instances details

(k ~ A_Lens, a ~ NotifyActionCompleteF p, b ~ NotifyActionCompleteF p) => LabelOptic "complete" k (NotifyActionsInit p) (NotifyActionsInit p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods labelOptic :: Optic k NoIx (NotifyActionsInit p) (NotifyActionsInit p) a b Source #
(k ~ A_Lens, a ~ SwitchF p NotifyActionStartSwitch, b ~ SwitchF p NotifyActionStartSwitch) => LabelOptic "start" k (NotifyActionsInit p) (NotifyActionsInit p) a b Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods labelOptic :: Optic k NoIx (NotifyActionsInit p) (NotifyActionsInit p) a b Source #
(NotifyActionCompleteF p ~ Maybe (WithDisabled NotifyActionComplete), SwitchF p NotifyActionStartSwitch ~ Maybe NotifyActionStartSwitch) => Monoid (NotifyActionsInit p) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods mempty :: NotifyActionsInit p # mappend :: NotifyActionsInit p -> NotifyActionsInit p -> NotifyActionsInit p # mconcat :: [NotifyActionsInit p] -> NotifyActionsInit p #
(NotifyActionCompleteF p ~ Maybe (WithDisabled NotifyActionComplete), SwitchF p NotifyActionStartSwitch ~ Maybe NotifyActionStartSwitch) => Semigroup (NotifyActionsInit p) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (<>) :: NotifyActionsInit p -> NotifyActionsInit p -> NotifyActionsInit p # sconcat :: NonEmpty (NotifyActionsInit p) -> NotifyActionsInit p # stimes :: Integral b => b -> NotifyActionsInit p -> NotifyActionsInit p #
Show (NotifyActionsInit 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyActionsInit 'ConfigPhaseArgs -> ShowS # show :: NotifyActionsInit 'ConfigPhaseArgs -> String # showList :: [NotifyActionsInit 'ConfigPhaseArgs] -> ShowS #
Show (NotifyActionsInit 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyActionsInit 'ConfigPhaseToml -> ShowS # show :: NotifyActionsInit 'ConfigPhaseToml -> String # showList :: [NotifyActionsInit 'ConfigPhaseToml] -> ShowS #
Eq (NotifyActionsInit 'ConfigPhaseArgs) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyActionsInit 'ConfigPhaseArgs -> NotifyActionsInit 'ConfigPhaseArgs -> Bool # (/=) :: NotifyActionsInit 'ConfigPhaseArgs -> NotifyActionsInit 'ConfigPhaseArgs -> Bool #
Eq (NotifyActionsInit 'ConfigPhaseToml) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyActionsInit 'ConfigPhaseToml -> NotifyActionsInit 'ConfigPhaseToml -> Bool # (/=) :: NotifyActionsInit 'ConfigPhaseToml -> NotifyActionsInit 'ConfigPhaseToml -> Bool #

NotifyActive

data NotifyActionsActive Source #

Holds active notif actions. This is morally These, specialized to our notify action use case.

Constructors

NotifyActionsActiveComplete NotifyActionComplete	Complete actions active.
NotifyActionsActiveStart	Start actions active.
NotifyActionsActiveAll NotifyActionComplete	All actions active.

Instances

Instances details

Show NotifyActionsActive Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyActionsActive -> ShowS # show :: NotifyActionsActive -> String # showList :: [NotifyActionsActive] -> ShowS #
Eq NotifyActionsActive Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyActionsActive -> NotifyActionsActive -> Bool # (/=) :: NotifyActionsActive -> NotifyActionsActive -> Bool #
Pretty NotifyActionsActive Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods pretty :: NotifyActionsActive -> Doc ann Source # prettyList :: [NotifyActionsActive] -> Doc ann Source #

_NotifyActionsActiveCompleteAny :: AffineFold NotifyActionsActive NotifyActionComplete Source #

_NotifyActionsActiveStartAny :: AffineFold NotifyActionsActive () Source #

Notify

data NotifyP (p :: ConfigPhase) r Source #

Holds notification config. We have an invariant that if the notify config exists (i.e. is Just), then at least one of actionComplete, actionStart should be Just/True.

Constructors

MkNotifyP
Fields actions :: NotifyActionsF p Notify actions. system :: NotifySystemF p r The notification system to use. timeout :: ConfigPhaseF p NotifyTimeout when to timeout successful notifications.

Instances

Instances details

(k ~ A_Lens, a ~ NotifyActionsF p, b ~ NotifyActionsF p) => LabelOptic "actions" k (NotifyP p r) (NotifyP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods labelOptic :: Optic k NoIx (NotifyP p r) (NotifyP p r) a b Source #
(k ~ A_Lens, a ~ NotifySystemF p r, b ~ NotifySystemF p r) => LabelOptic "system" k (NotifyP p r) (NotifyP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods labelOptic :: Optic k NoIx (NotifyP p r) (NotifyP p r) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseF p NotifyTimeout, b ~ ConfigPhaseF p NotifyTimeout) => LabelOptic "timeout" k (NotifyP p r) (NotifyP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods labelOptic :: Optic k NoIx (NotifyP p r) (NotifyP p r) a b Source #
Monoid (NotifyToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods mempty :: NotifyToml r # mappend :: NotifyToml r -> NotifyToml r -> NotifyToml r # mconcat :: [NotifyToml r] -> NotifyToml r #
Semigroup (NotifyToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (<>) :: NotifyToml r -> NotifyToml r -> NotifyToml r # sconcat :: NonEmpty (NotifyToml r) -> NotifyToml r # stimes :: Integral b => b -> NotifyToml r -> NotifyToml r #
Pretty (NotifyMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods pretty :: NotifyMerged r -> Doc ann Source # prettyList :: [NotifyMerged r] -> Doc ann Source #
Default (NotifyArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods def :: NotifyArgs r Source #
DecodeTOML (NotifyToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods tomlDecoder :: Decoder (NotifyToml r) Source #
Show (NotifyP 'ConfigPhaseArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyP 'ConfigPhaseArgs r -> ShowS # show :: NotifyP 'ConfigPhaseArgs r -> String # showList :: [NotifyP 'ConfigPhaseArgs r] -> ShowS #
Show (NotifyP 'ConfigPhaseMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyP 'ConfigPhaseMerged r -> ShowS # show :: NotifyP 'ConfigPhaseMerged r -> String # showList :: [NotifyP 'ConfigPhaseMerged r] -> ShowS #
Show (NotifyP 'ConfigPhaseToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods showsPrec :: Int -> NotifyP 'ConfigPhaseToml r -> ShowS # show :: NotifyP 'ConfigPhaseToml r -> String # showList :: [NotifyP 'ConfigPhaseToml r] -> ShowS #
Eq (NotifyP 'ConfigPhaseArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyP 'ConfigPhaseArgs r -> NotifyP 'ConfigPhaseArgs r -> Bool # (/=) :: NotifyP 'ConfigPhaseArgs r -> NotifyP 'ConfigPhaseArgs r -> Bool #
Eq (NotifyP 'ConfigPhaseMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyP 'ConfigPhaseMerged r -> NotifyP 'ConfigPhaseMerged r -> Bool # (/=) :: NotifyP 'ConfigPhaseMerged r -> NotifyP 'ConfigPhaseMerged r -> Bool #
Eq (NotifyP 'ConfigPhaseToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Notify Methods (==) :: NotifyP 'ConfigPhaseToml r -> NotifyP 'ConfigPhaseToml r -> Bool # (/=) :: NotifyP 'ConfigPhaseToml r -> NotifyP 'ConfigPhaseToml r -> Bool #

type NotifyArgs = NotifyP 'ConfigPhaseArgs Source #

type NotifyToml = NotifyP 'ConfigPhaseToml Source #

type NotifyMerged = NotifyP 'ConfigPhaseMerged Source #

type NotificationEnv = NotifyP 'ConfigPhaseEnv Source #

mergeNotifications :: NotifyArgs r -> Maybe (NotifyToml r) -> Maybe (NotifyMerged r) Source #

Merges args and toml configs.

toEnv :: (HasCallStack, MonadNotify m, MonadThrow m, NotifyEnvF m ~ r) => NotifyMerged r -> m (NotifyP 'ConfigPhaseEnv r) Source #