| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Options.Harg.Sources.Types
Synopsis
- data SourceRunResult a
- = OptNotFound
- | OptParsed a
- data SourceRunError = SourceRunError {}
- sourceRunError :: forall a. Opt a -> String -> String -> SourceRunError
- class GetSource (c :: (Type -> Type) -> Type) (f :: Type -> Type) where
- class RunSource s a where
- runSource :: Applicative f => s -> a (Compose Opt f) -> [Either SourceRunError (a (Compose SourceRunResult f))]
- data ConfigFile
Documentation
data SourceRunResult a Source #
Holds errors that occur when running a source.
Constructors
| OptNotFound | Source doesn't include the option |
| OptParsed a | Successful parsing |
Instances
| Functor SourceRunResult Source # | |
Defined in Options.Harg.Sources.Types Methods fmap :: (a -> b) -> SourceRunResult a -> SourceRunResult b # (<$) :: a -> SourceRunResult b -> SourceRunResult a # | |
data SourceRunError Source #
Constructors
| SourceRunError | |
sourceRunError :: forall a. Opt a -> String -> String -> SourceRunError Source #
Create a SourceRunError by existentially wrapping an option in SomeOpt.
class GetSource (c :: (Type -> Type) -> Type) (f :: Type -> Type) where Source #
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 Source #
The type that will be returned when the source is read.
Instances
| GetSource NoSource f Source # | |
| GetSource EnvSource f Source # | |
| GetSource DefaultStrSource f Source # | |
Defined in Options.Harg.Sources.DefaultStr Associated Types type SourceVal DefaultStrSource :: Type Source # Methods getSource :: HargCtx -> DefaultStrSource f -> IO (SourceVal DefaultStrSource) Source # | |
| GetSource YAMLSource Identity Source # | |
Defined in Options.Harg.Sources.YAML Associated Types type SourceVal YAMLSource :: Type Source # Methods getSource :: HargCtx -> YAMLSource Identity -> IO (SourceVal YAMLSource) Source # | |
| GetSource JSONSource Identity Source # | |
Defined in Options.Harg.Sources.JSON Associated Types type SourceVal JSONSource :: Type Source # Methods getSource :: HargCtx -> JSONSource Identity -> IO (SourceVal JSONSource) Source # | |
| (GetSource l f, GetSource r f) => GetSource (l :* r) f Source # | |
class RunSource s a where Source #
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))] Source #
Instances
data ConfigFile Source #
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 Source # | |
Defined in Options.Harg.Sources.Types Methods fromString :: String -> ConfigFile # | |