decode package:yaml

decode :: FromJSON a => ByteString -> Maybe a

yaml Data.Yaml

Deprecated: Please use decodeEither or decodeThrow, which provide information on how the decode failed

decodeAllEither' :: FromJSON a => ByteString -> Either ParseException [a]

yaml Data.Yaml

Like decodeEither', but decode multiple documents.

decodeAllFileEither :: FromJSON a => FilePath -> IO (Either ParseException [a])

yaml Data.Yaml

Like decodeFileEither, but decode multiple documents.

decodeAllFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m [a]

yaml Data.Yaml

Like decodeFileThrow, but decode multiple documents.

decodeAllFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], [a]))

yaml Data.Yaml

Like decodeFileWithWarnings, but decode multiple documents.

decodeAllThrow :: (MonadThrow m, FromJSON a) => ByteString -> m [a]

yaml Data.Yaml

Like decodeThrow, but decode multiple documents.

decodeEither :: FromJSON a => ByteString -> Either String a

yaml Data.Yaml

Deprecated: Please use decodeEither' or decodeThrow, which provide more useful failures

decodeEither' :: FromJSON a => ByteString -> Either ParseException a

yaml Data.Yaml

More helpful version of decodeEither which returns the YamlException.

decodeFile :: FromJSON a => FilePath -> IO (Maybe a)

yaml Data.Yaml

Deprecated: Please use decodeFileEither, which does not confused type-directed and runtime exceptions.

decodeFileEither :: FromJSON a => FilePath -> IO (Either ParseException a)

yaml Data.Yaml

A version of decodeFile which should not throw runtime exceptions.

decodeFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m a

yaml Data.Yaml

A version of decodeFileEither lifted to MonadIO

decodeFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], a))

yaml Data.Yaml Data.Yaml.Include

A version of decodeFileEither that returns warnings along with the parse result.

decodeHelper :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], Either String a))

yaml Data.Yaml Data.Yaml.Internal

decodeThrow :: (MonadThrow m, FromJSON a) => ByteString -> m a

yaml Data.Yaml

A version of decodeEither' lifted to MonadThrow

decodeFile :: FromJSON a => FilePath -> IO (Maybe a)

yaml Data.Yaml.Include

Like decodeFile but with support for relative and absolute includes. The syntax for includes follows the form:

somekey: !include ./somefile.yaml

decodeFileEither :: FromJSON a => FilePath -> IO (Either ParseException a)

yaml Data.Yaml.Include

Like decodeFileEither but with support for relative and absolute includes. The syntax for includes follows the form:

somekey: !include ./somefile.yaml

decodeAllHelper :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], Either String [a]))

yaml Data.Yaml.Internal

decodeAllHelper_ :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], [a]))

yaml Data.Yaml.Internal

decodeHelper_ :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], a))

yaml Data.Yaml.Internal

decodeFile :: forall a . (Lift a, FromJSON a) => FilePath -> Q (TExp a)

yaml Data.Yaml.TH

Decode a YAML file at compile time. Only available on GHC version 7.8.1 or higher.

Examples

{-# LANGUAGE TemplateHaskell #-}

config :: Config
config = $$(decodeFile "config.yaml")