Options.Harg.Sources.Types

Documentation

class GetSource (c :: (Type -> Type) -> Type) (f :: Type -> Type) where

This class enables a type that describes a source to fetch the source contents, potentially producing side effects (e.g. reading a file).

Associated Types

type SourceVal c :: Type

The type that will be returned when the source is read.

Methods

getSource :: HargCtx -> c f -> IO (SourceVal c)

Instances

GetSource NoSource f

Defined in Options.Harg.Sources.NoSource

Associated Types

type SourceVal NoSource

Methods

getSource :: HargCtx -> NoSource f -> IO (SourceVal NoSource)

GetSource EnvSource f

Defined in Options.Harg.Sources.Env

Associated Types

type SourceVal EnvSource

Methods

getSource :: HargCtx -> EnvSource f -> IO (SourceVal EnvSource)

GetSource DefaultStrSource f

Defined in Options.Harg.Sources.DefaultStr

Associated Types

type SourceVal DefaultStrSource

Methods

getSource :: HargCtx -> DefaultStrSource f -> IO (SourceVal DefaultStrSource)

GetSource YAMLSource Identity

Defined in Options.Harg.Sources.YAML

Associated Types

type SourceVal YAMLSource

Methods

getSource :: HargCtx -> YAMLSource Identity -> IO (SourceVal YAMLSource)

GetSource JSONSource Identity

Defined in Options.Harg.Sources.JSON

Associated Types

type SourceVal JSONSource

Methods

getSource :: HargCtx -> JSONSource Identity -> IO (SourceVal JSONSource)

(GetSource l f, GetSource r f) => GetSource (l :* r) f

Defined in Options.Harg.Sources.Types

Associated Types

type SourceVal (l :* r)

Methods

getSource :: HargCtx -> (l :* r) f -> IO (SourceVal (l :* r))

class RunSource s a where

This class is used to run the result of running getSource on the configuration options. In order for it to work, all types used in the source configuration need to have a GetSource instance, and their associated SourceVal types need to have a RunSource instance.

Methods

runSource :: Applicative f => s -> a (Compose Opt f) -> [Either SourceRunError (a (Compose SourceRunResult f))]

Instances

RunSource () a

Defined in Options.Harg.Sources.Types

Methods

runSource :: forall (f :: Type -> Type). Applicative f => () -> a (Compose Opt f) -> [Either SourceRunError (a (Compose SourceRunResult f))]

(FunctorB a, TraversableB a) => RunSource EnvSourceVal a

Defined in Options.Harg.Sources.Env

Methods

runSource :: forall (f :: Type -> Type). Applicative f => EnvSourceVal -> a (Compose Opt f) -> [Either SourceRunError (a (Compose SourceRunResult f))]

(RunSource l a, RunSource r a) => RunSource (l, r) a

Defined in Options.Harg.Sources.Types

Methods

runSource :: forall (f :: Type -> Type). Applicative f => (l, r) -> a (Compose Opt f) -> [Either SourceRunError (a (Compose SourceRunResult f))]

data ConfigFile

This type describes configuration files, for use with e.g. the JSON source. The reason to not use FilePath directly is that the user might prefer to do nothing if the option for the config file has not been not provided, and there's no default. Because this type has an IsString instance, it's very easy to define an option. For example, to define a json source with a default value:

  srcOpt :: JSONSource Opt
  srcOpt = JSONSource jsonOpt
    where
      jsonOpt
        = optionWith strParser
            ( long "json-config"
            . defaultVal (ConfigFile "~/config.json")
            )

And an optional JSON source:

  srcOpt :: JSONSource Opt
  srcOpt = JSONSource jsonOpt
    where
      jsonOpt
        = optionWith strParser
            ( long "json-config"
            . defaultVal NoConfigFile
            )

Constructors

ConfigFile FilePath

NoConfigFile

Instances

IsString ConfigFile

Defined in Options.Harg.Sources.Types

Methods

fromString :: String -> ConfigFile

data SourceRunResult a

Holds errors that occur when running a source.

Constructors

OptNotFound

Source doesn't include the option

OptParsed a

Successful parsing

Instances

Functor SourceRunResult

Defined in Options.Harg.Sources.Types

Methods

fmap :: (a -> b) -> SourceRunResult a -> SourceRunResult b

(<$) :: a -> SourceRunResult b -> SourceRunResult a

data SourceRunError

Constructors

SourceRunError

Fields

• _sreOpt :: Maybe SomeOpt
• _sreSourceName :: String
• _sreError :: String

sourceRunError :: forall a. Opt a -> String -> String -> SourceRunError

Create a SourceRunError by existentially wrapping an option in SomeOpt.