Data.Settings.Types

Documentation

data Option m

A settings option. The option value itself is held as usual in regular application state, not here. What is held here is functions applied to that state to get or set the value.

Constructors

Option

Fields

• optGet :: m Text

  A monadic action which returns the value of the option.

• optSet :: Text -> m (Maybe SettingsError)

  A monadic action which tries to set the option to the given valie, and returns whether it succeeded.

• optReset :: m ()

  A monadic action which resets the option to its default value.

data Section m

A settings section in the settings UI tree.

Constructors

Section

Fields

• secOpts :: HashMap Text (Option m)

  The options located under this section.

• secSubs :: HashMap Text (Section m)

  Subsections located under this section.

type OptName = Text

An opion name.

type SecName = Text

A section name.

type OptPath = Text

An option path string.

type OptRoute = [Text]

An option route, i.e. a list of section names ending with an option name, which describes a path in the settings UI tree leading to that option.

data SettingsError

An error occuring during an operation on the settings.

Constructors

InvalidPath OptPath

NoSuchOption OptRoute

NoSuchSection OptRoute

NoSuchNode OptRoute

InvalidValueForType Text

InvalidValue Text

class OptionValue v where

Minimal complete definition

readOption, showOption, typeName

Methods

readOption :: Text -> Maybe v

showOption :: v -> Text

typeName :: v -> Text

class Monad m => MonadSettings m s | m -> s where

Minimal complete definition

getSettings, putSettings, modifySettings, getSTree

Methods

getSettings :: m s

putSettings :: s -> m ()

modifySettings :: (s -> s) -> m ()

getSTree :: m (Section m)