Safe Haskell	None
Language	GHC2021

Navi.Config

Contents

Description

This modules provides functionality for parsing configuration data from a toml file.

Synopsis

Config

Parses the provided toml file into a Config. Throws ConfigErr if anything goes wrong.

ConfigErr represents the errors we can encounter when attempting to parse a config file.

Constructors

Instances details

Exception ConfigErr Source #
Instance details Defined in Navi.Config.Types Methods toException :: ConfigErr -> SomeException # fromException :: SomeException -> Maybe ConfigErr # displayException :: ConfigErr -> String # backtraceDesired :: ConfigErr -> Bool #
Show ConfigErr Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> ConfigErr -> ShowS # show :: ConfigErr -> String # showList :: [ConfigErr] -> ShowS #

Config holds the data from ConfigToml once it has been processed (e.g., all user defined Events are parsed).

Constructors

MkConfig
Fields events :: NonEmpty AnyEvent The notification events. logging :: Logging Logging configuration. noteSystem :: NoteSystem 'ConfigPhaseToml The notification system to use.

Instances details

Show Config Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
(k ~ A_Lens, a ~ NonEmpty AnyEvent, b ~ NonEmpty AnyEvent) => LabelOptic "events" k Config Config a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Config Config a b Source #
(k ~ A_Lens, a ~ Logging, b ~ Logging) => LabelOptic "logging" k Config Config a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Config Config a b Source #
(k ~ A_Lens, a ~ NoteSystem 'ConfigPhaseToml, b ~ NoteSystem 'ConfigPhaseToml) => LabelOptic "noteSystem" k Config Config a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Config Config a b Source #

Logging

Logging configuration.

Constructors

MkLogging
Fields severity :: Maybe LogLevel Determines the log level. location :: Maybe LogLoc Determines the log location (i.e. file or stdout). sizeMode :: Maybe FilesSizeMode Determines whether to warn/delete large log files.

Instances details

Show Logging Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> Logging -> ShowS # show :: Logging -> String # showList :: [Logging] -> ShowS #
Eq Logging Source #
Instance details Defined in Navi.Config.Types Methods (==) :: Logging -> Logging -> Bool # (/=) :: Logging -> Logging -> Bool #
(k ~ A_Lens, a ~ Maybe LogLoc, b ~ Maybe LogLoc) => LabelOptic "location" k Logging Logging a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Logging Logging a b Source #
(k ~ A_Lens, a ~ Maybe LogLevel, b ~ Maybe LogLevel) => LabelOptic "severity" k Logging Logging a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Logging Logging a b Source #
(k ~ A_Lens, a ~ Maybe FilesSizeMode, b ~ Maybe FilesSizeMode) => LabelOptic "sizeMode" k Logging Logging a b Source #
Instance details Defined in Navi.Config.Types Methods labelOptic :: Optic k NoIx Logging Logging a b Source #

Log location configuration.

Constructors

Instances details

Show LogLoc Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> LogLoc -> ShowS # show :: LogLoc -> String # showList :: [LogLoc] -> ShowS #
Eq LogLoc Source #
Instance details Defined in Navi.Config.Types Methods (==) :: LogLoc -> LogLoc -> Bool # (/=) :: LogLoc -> LogLoc -> Bool #

Configuration for notification systems.

Constructors

AppleScript	For use with osx.
DBus (DBusF p)	For use with a running notification server that receives messages via DBus.
NotifySend	For use with the notify-send tool.

Instances details

Show (NoteSystem 'ConfigPhaseToml) Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> NoteSystem 'ConfigPhaseToml -> ShowS # show :: NoteSystem 'ConfigPhaseToml -> String # showList :: [NoteSystem 'ConfigPhaseToml] -> ShowS #
Eq (NoteSystem 'ConfigPhaseToml) Source #
Instance details Defined in Navi.Config.Types Methods (==) :: NoteSystem 'ConfigPhaseToml -> NoteSystem 'ConfigPhaseToml -> Bool # (/=) :: NoteSystem 'ConfigPhaseToml -> NoteSystem 'ConfigPhaseToml -> Bool #