Safe Haskell	None
Language	Haskell2010

Options.Harg.Sources.YAML

Synopsis

newtype YAMLSource f = YAMLSource (f ConfigFile)
data YAMLSourceVal
- = YAMLSourceVal ByteString
- | YAMLSourceNotRequired
runYAMLSource :: forall a f. (FunctorB a, FromJSON (a Maybe), Applicative f) => ByteString -> a (Compose Opt f) -> a (Compose SourceRunResult f)

Documentation

newtype YAMLSource f Source #

Source that enables a parser to read options from a YAML file.

Constructors

YAMLSource (f ConfigFile)

Instances

GetSource YAMLSource Identity Source #
Instance details Defined in Options.Harg.Sources.YAML Associated Types type SourceVal YAMLSource :: Type Source # Methods getSource :: HargCtx -> YAMLSource Identity -> IO (SourceVal YAMLSource) Source #
Generic (YAMLSource f) Source #
Instance details Defined in Options.Harg.Sources.YAML Associated Types type Rep (YAMLSource f) :: Type -> Type # Methods from :: YAMLSource f -> Rep (YAMLSource f) x # to :: Rep (YAMLSource f) x -> YAMLSource f #
ProductB YAMLSource Source #
Instance details Defined in Options.Harg.Sources.YAML Methods bprod :: YAMLSource f -> YAMLSource g -> YAMLSource (Product f g) # buniq :: (forall (a :: k). f a) -> YAMLSource f #
TraversableB YAMLSource Source #
Instance details Defined in Options.Harg.Sources.YAML Methods btraverse :: Applicative t => (forall (a :: k). f a -> t (g a)) -> YAMLSource f -> t (YAMLSource g) #
FunctorB YAMLSource Source #
Instance details Defined in Options.Harg.Sources.YAML Methods bmap :: (forall (a :: k). f a -> g a) -> YAMLSource f -> YAMLSource g #
type SourceVal YAMLSource Source #
Instance details Defined in Options.Harg.Sources.YAML type SourceVal YAMLSource = YAMLSourceVal
type Rep (YAMLSource f) Source #
Instance details Defined in Options.Harg.Sources.YAML type Rep (YAMLSource f) = D1 (MetaData "YAMLSource" "Options.Harg.Sources.YAML" "harg-0.4.0.0-inplace" True) (C1 (MetaCons "YAMLSource" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f ConfigFile))))

data YAMLSourceVal Source #

The result of reading a YAML file. YAMLSourceNotRequired is used when the user has specified defaultVal NoConfigFile. It holds the contents of the YAML file as a ByteString.

Constructors

YAMLSourceVal ByteString
YAMLSourceNotRequired

Instances

(FromJSON (a Maybe), FunctorB a) => RunSource YAMLSourceVal a Source #
Instance details Defined in Options.Harg.Sources.YAML Methods runSource :: Applicative f => YAMLSourceVal -> a (Compose Opt f) -> [a (Compose SourceRunResult f)] Source #

runYAMLSource :: forall a f. (FunctorB a, FromJSON (a Maybe), Applicative f) => ByteString -> a (Compose Opt f) -> a (Compose SourceRunResult f) Source #