Safe Haskell	Safe-Inferred
Language	GHC2021

Navi.Config.Types

Contents

Config
Logging
Note System

Description

Provides configuration types.

Synopsis

data Config = MkConfig {
- events :: !(NonEmpty AnyEvent)
- logging :: !Logging
- noteSystem :: !NoteSystem
}
data ConfigErr
- = FileErr !SomeException
- | TomlError !TOMLError
- | NoEvents
_FileErr :: Prism' ConfigErr SomeException
_TomlError :: Prism' ConfigErr TOMLError
_NoEvents :: Prism' ConfigErr ()
data Logging = MkLogging {
- severity :: !(Maybe LogLevel)
- location :: !(Maybe LogLoc)
}
data LogLoc
- = DefPath
- | Stdout
- | File !Path
_DefPath :: Prism' LogLoc ()
_Stdout :: Prism' LogLoc ()
_File :: Prism' LogLoc Path
defaultLogging :: Logging
data NoteSystem
- = DBus
- | NotifySend
_DBus :: Prism' NoteSystem ()
_NotifySend :: Prism' NoteSystem ()
defaultNoteSystem :: NoteSystem

Config

data Config Source #

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 The notification system to use.

Instances

Instances details

Show Config Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> Config -> ShowS Source # show :: Config -> String Source # showList :: [Config] -> ShowS Source #
(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, b ~ NoteSystem) => 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 #

data ConfigErr Source #

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

Constructors

FileErr !SomeException
TomlError !TOMLError
NoEvents

Instances

Instances details

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

_FileErr :: Prism' ConfigErr SomeException Source #

_TomlError :: Prism' ConfigErr TOMLError Source #

_NoEvents :: Prism' ConfigErr () Source #

Logging

data Logging Source #

Logging configuration.

Constructors

MkLogging
Fields severity :: !(Maybe LogLevel) Determines the log level. location :: !(Maybe LogLoc) Deterines the log location (i.e. file or stdout).

Instances

Instances details

Show Logging Source #
Instance details Defined in Navi.Config.Types Methods showsPrec :: Int -> Logging -> ShowS Source # show :: Logging -> String Source # showList :: [Logging] -> ShowS Source #
Eq Logging Source #
Instance details Defined in Navi.Config.Types Methods (==) :: Logging -> Logging -> Bool Source # (/=) :: Logging -> Logging -> Bool Source #
(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 #

data LogLoc Source #

Log location configuration.

Constructors

DefPath
Stdout
File !Path

Instances

Instances details

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

_DefPath :: Prism' LogLoc () Source #

_Stdout :: Prism' LogLoc () Source #

_File :: Prism' LogLoc Path Source #

defaultLogging :: Logging Source #

Default logging i.e. log errors and use the default path.

Note System

data NoteSystem Source #

Configuration for notification systems.

Constructors

DBus	For use with a running notification server that receives messages via DBus.
NotifySend	For use with the notify-send tool.

Instances

Instances details

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

_DBus :: Prism' NoteSystem () Source #

_NotifySend :: Prism' NoteSystem () Source #

defaultNoteSystem :: NoteSystem Source #

Default notification system i.e. DBus.