Safe Haskell	None
Language	GHC2021

Shrun.Notify.Types

Contents

Notify system
Notify actions
Notify timeout
Exceptions

Description

Provides type for notifications.

Synopsis

data NotifySystemP (p :: ConfigPhase)
- = DBus (DBusF p)
- | NotifySend
- | AppleScript
type NotifySystemArgs = NotifySystemP 'ConfigPhaseArgs
type NotifySystemToml = NotifySystemP 'ConfigPhaseToml
type NotifySystemMerged = NotifySystemP 'ConfigPhaseMerged
type NotifySystemEnv = NotifySystemP 'ConfigPhaseEnv
parseNotifySystem :: forall (p :: ConfigPhase) m. (DBusF p ~ (), MonadFail m) => m Text -> m (NotifySystemP p)
notifySystemStr :: IsString a => a
showNotifySystem :: forall a (p :: ConfigPhase). IsString a => NotifySystemP p -> a
displayNotifySystem :: forall a (p :: ConfigPhase). IsString a => NotifySystemP p -> a
type family DBusF (p :: ConfigPhase) where ...
mergeNotifySystem :: WithDisabled NotifySystemArgs -> Maybe NotifySystemToml -> NotifySystemMerged
data NotifyAction
- = NotifyFinal
- | NotifyCommand
- | NotifyAll
parseNotifyAction :: MonadFail m => m Text -> m NotifyAction
notifyActionStr :: IsString a => a
data NotifyTimeout
- = NotifyTimeoutSeconds Word16
- | NotifyTimeoutNever
parseNotifyTimeout :: MonadFail m => m Text -> m NotifyTimeout
notifyTimeoutStr :: IsString a => a
data OsxNotifySystemMismatch
- = OsxNotifySystemMismatchDBus
- | OsxNotifySystemMismatchNotifySend
data LinuxNotifySystemMismatch = LinuxNotifySystemMismatchAppleScript

Notify system

data NotifySystemP (p :: ConfigPhase) Source #

Notification systems.

Constructors

DBus (DBusF p)	Uses DBus.
NotifySend	Uses notify-send.
AppleScript	Uses apple-script.

Instances

Instances details

Show NotifySystemArgs Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> NotifySystemArgs -> ShowS # show :: NotifySystemArgs -> String # showList :: [NotifySystemArgs] -> ShowS #
Show NotifySystemMerged Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> NotifySystemMerged -> ShowS # show :: NotifySystemMerged -> String # showList :: [NotifySystemMerged] -> ShowS #
Show NotifySystemToml Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> NotifySystemToml -> ShowS # show :: NotifySystemToml -> String # showList :: [NotifySystemToml] -> ShowS #
Eq NotifySystemArgs Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: NotifySystemArgs -> NotifySystemArgs -> Bool # (/=) :: NotifySystemArgs -> NotifySystemArgs -> Bool #
Eq NotifySystemMerged Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: NotifySystemMerged -> NotifySystemMerged -> Bool # (/=) :: NotifySystemMerged -> NotifySystemMerged -> Bool #
Eq NotifySystemToml Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: NotifySystemToml -> NotifySystemToml -> Bool # (/=) :: NotifySystemToml -> NotifySystemToml -> Bool #
DecodeTOML NotifySystemToml Source #
Instance details Defined in Shrun.Notify.Types Methods tomlDecoder :: Decoder NotifySystemToml Source #
DBusF p ~ () => Default (NotifySystemP p) Source #
Instance details Defined in Shrun.Notify.Types Methods def :: NotifySystemP p Source #

type NotifySystemArgs = NotifySystemP 'ConfigPhaseArgs Source #

type NotifySystemToml = NotifySystemP 'ConfigPhaseToml Source #

type NotifySystemMerged = NotifySystemP 'ConfigPhaseMerged Source #

type NotifySystemEnv = NotifySystemP 'ConfigPhaseEnv Source #

parseNotifySystem :: forall (p :: ConfigPhase) m. (DBusF p ~ (), MonadFail m) => m Text -> m (NotifySystemP p) Source #

Parses NotifySystem.

notifySystemStr :: IsString a => a Source #

Available NotifySystem strings.

showNotifySystem :: forall a (p :: ConfigPhase). IsString a => NotifySystemP p -> a Source #

displayNotifySystem :: forall a (p :: ConfigPhase). IsString a => NotifySystemP p -> a Source #

type family DBusF (p :: ConfigPhase) where ... Source #

Maps DBus to its phased param.

Equations

DBusF 'ConfigPhaseArgs = ()
DBusF 'ConfigPhaseToml = ()
DBusF 'ConfigPhaseMerged = ()
DBusF 'ConfigPhaseEnv = Client

mergeNotifySystem :: WithDisabled NotifySystemArgs -> Maybe NotifySystemToml -> NotifySystemMerged Source #

Merges notify systems.

Notify actions

data NotifyAction Source #

Determines for which actions we should send notifications.

Constructors

NotifyFinal	Send a notification after all commands are completed.
NotifyCommand	Send notifications when each command completes.
NotifyAll	NotifyFinal and NotifyCommand.

Instances

Instances details

Show NotifyAction Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> NotifyAction -> ShowS # show :: NotifyAction -> String # showList :: [NotifyAction] -> ShowS #
Eq NotifyAction Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: NotifyAction -> NotifyAction -> Bool # (/=) :: NotifyAction -> NotifyAction -> Bool #
DecodeTOML NotifyAction Source #
Instance details Defined in Shrun.Notify.Types Methods tomlDecoder :: Decoder NotifyAction Source #

parseNotifyAction :: MonadFail m => m Text -> m NotifyAction Source #

Parses NotifyAction.

notifyActionStr :: IsString a => a Source #

Available NotifyAction strings.

Notify timeout

data NotifyTimeout Source #

Determines notification timeout.

Constructors

NotifyTimeoutSeconds Word16	Times out after the given seconds.
NotifyTimeoutNever	Never times out.

Instances

Instances details

FromInteger NotifyTimeout Source #
Instance details Defined in Shrun.Notify.Types Methods afromInteger :: Integer -> NotifyTimeout Source #
Show NotifyTimeout Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> NotifyTimeout -> ShowS # show :: NotifyTimeout -> String # showList :: [NotifyTimeout] -> ShowS #
Eq NotifyTimeout Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: NotifyTimeout -> NotifyTimeout -> Bool # (/=) :: NotifyTimeout -> NotifyTimeout -> Bool #
Default NotifyTimeout Source #
Instance details Defined in Shrun.Notify.Types Methods def :: NotifyTimeout Source #
DecodeTOML NotifyTimeout Source #
Instance details Defined in Shrun.Notify.Types Methods tomlDecoder :: Decoder NotifyTimeout Source #

parseNotifyTimeout :: MonadFail m => m Text -> m NotifyTimeout Source #

Parses NotifyTimeout.

notifyTimeoutStr :: IsString a => a Source #

Available NotifyTimeout strings.

Exceptions

data OsxNotifySystemMismatch Source #

Constructors

OsxNotifySystemMismatchDBus
OsxNotifySystemMismatchNotifySend

Instances

Instances details

Exception OsxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods toException :: OsxNotifySystemMismatch -> SomeException # fromException :: SomeException -> Maybe OsxNotifySystemMismatch # displayException :: OsxNotifySystemMismatch -> String #
Show OsxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> OsxNotifySystemMismatch -> ShowS # show :: OsxNotifySystemMismatch -> String # showList :: [OsxNotifySystemMismatch] -> ShowS #
Eq OsxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: OsxNotifySystemMismatch -> OsxNotifySystemMismatch -> Bool # (/=) :: OsxNotifySystemMismatch -> OsxNotifySystemMismatch -> Bool #

data LinuxNotifySystemMismatch Source #

Constructors

LinuxNotifySystemMismatchAppleScript

Instances

Instances details

Exception LinuxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods toException :: LinuxNotifySystemMismatch -> SomeException # fromException :: SomeException -> Maybe LinuxNotifySystemMismatch # displayException :: LinuxNotifySystemMismatch -> String #
Show LinuxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods showsPrec :: Int -> LinuxNotifySystemMismatch -> ShowS # show :: LinuxNotifySystemMismatch -> String # showList :: [LinuxNotifySystemMismatch] -> ShowS #
Eq LinuxNotifySystemMismatch Source #
Instance details Defined in Shrun.Notify.Types Methods (==) :: LinuxNotifySystemMismatch -> LinuxNotifySystemMismatch -> Bool # (/=) :: LinuxNotifySystemMismatch -> LinuxNotifySystemMismatch -> Bool #