| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Data.Yaml
Description
Provides a high-level interface for processing YAML files.
This module reuses most of the infrastructure from the aeson package.
This means that you can use all of the existing tools for JSON
processing for processing YAML files. As a result, much of the
documentation below mentions JSON; do not let that confuse you, it's
intentional.
For the most part, YAML content translates directly into JSON, and therefore there is very little data loss. If you need to deal with YAML more directly (e.g., directly deal with aliases), you should use the Text.Libyaml module instead.
For documentation on the aeson types, functions, classes, and
operators, please see the Data.Aeson module of the aeson package.
Look in the examples directory of the source repository for some initial pointers on how to use this library.
Synopsis
- encode :: ToJSON a => a -> ByteString
- encodeWith :: ToJSON a => EncodeOptions -> a -> ByteString
- encodeFile :: ToJSON a => FilePath -> a -> IO ()
- encodeFileWith :: ToJSON a => EncodeOptions -> FilePath -> a -> IO ()
- decodeEither' :: FromJSON a => ByteString -> Either ParseException a
- decodeFileEither :: FromJSON a => FilePath -> IO (Either ParseException a)
- decodeFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], a))
- decodeThrow :: (MonadThrow m, FromJSON a) => ByteString -> m a
- decodeFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m a
- decodeAllEither' :: FromJSON a => ByteString -> Either ParseException [a]
- decodeAllFileEither :: FromJSON a => FilePath -> IO (Either ParseException [a])
- decodeAllFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], [a]))
- decodeAllThrow :: (MonadThrow m, FromJSON a) => ByteString -> m [a]
- decodeAllFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m [a]
- decodeHelper :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], Either String a))
- data Value
- data Parser a
- type Object = KeyMap Value
- type Array = Vector Value
- data ParseException
- prettyPrintParseException :: ParseException -> String
- data YamlException
- data YamlMark = YamlMark {}
- object :: [Pair] -> Value
- array :: [Value] -> Value
- (.=) :: (KeyValue kv, ToJSON v) => Key -> v -> kv
- (.:) :: FromJSON a => Object -> Key -> Parser a
- (.:?) :: FromJSON a => Object -> Key -> Parser (Maybe a)
- (.!=) :: Parser (Maybe a) -> a -> Parser a
- withObject :: String -> (Object -> Parser a) -> Value -> Parser a
- withText :: String -> (Text -> Parser a) -> Value -> Parser a
- withArray :: String -> (Array -> Parser a) -> Value -> Parser a
- withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a
- withBool :: String -> (Bool -> Parser a) -> Value -> Parser a
- parseMonad :: MonadFail m => (a -> Parser b) -> a -> m b
- parseEither :: (a -> Parser b) -> a -> Either String b
- parseMaybe :: (a -> Parser b) -> a -> Maybe b
- class ToJSON a where
- toJSON :: a -> Value
- toEncoding :: a -> Encoding
- toJSONList :: [a] -> Value
- toEncodingList :: [a] -> Encoding
- class FromJSON a where
- isSpecialString :: Text -> Bool
- data EncodeOptions
- defaultEncodeOptions :: EncodeOptions
- defaultStringStyle :: StringStyle
- setStringStyle :: (Text -> (Tag, Style)) -> EncodeOptions -> EncodeOptions
- setFormat :: FormatOptions -> EncodeOptions -> EncodeOptions
- data FormatOptions
- defaultFormatOptions :: FormatOptions
- setWidth :: Maybe Int -> FormatOptions -> FormatOptions
- decode :: FromJSON a => ByteString -> Maybe a
- decodeFile :: FromJSON a => FilePath -> IO (Maybe a)
- decodeEither :: FromJSON a => ByteString -> Either String a
Encoding
encode :: ToJSON a => a -> ByteString Source #
Encode a value into its YAML representation.
encodeWith :: ToJSON a => EncodeOptions -> a -> ByteString Source #
Encode a value into its YAML representation with custom styling.
Since: 0.10.2.0
encodeFile :: ToJSON a => FilePath -> a -> IO () Source #
Encode a value into its YAML representation and save to the given file.
encodeFileWith :: ToJSON a => EncodeOptions -> FilePath -> a -> IO () Source #
Encode a value into its YAML representation with custom styling and save to the given file.
Since: 0.10.2.0
Decoding
decodeEither' :: FromJSON a => ByteString -> Either ParseException a Source #
More helpful version of decodeEither which returns the YamlException.
Since: 0.8.3
decodeFileEither :: FromJSON a => FilePath -> IO (Either ParseException a) Source #
A version of decodeFile which should not throw runtime exceptions.
Since: 0.8.4
decodeFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], a)) Source #
A version of decodeFileEither that returns warnings along with the parse
result.
Since: 0.10.0
decodeThrow :: (MonadThrow m, FromJSON a) => ByteString -> m a Source #
A version of decodeEither' lifted to MonadThrow
Since: 0.8.31
decodeFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m a Source #
A version of decodeFileEither lifted to MonadIO
Since: 0.8.31
Decoding multiple documents
For situations where we need to be able to parse multiple documents separated by `---` in a YAML stream, these functions decode a list of values rather than a single value.
decodeAllEither' :: FromJSON a => ByteString -> Either ParseException [a] Source #
Like decodeEither', but decode multiple documents.
Since: 0.11.5.0
decodeAllFileEither :: FromJSON a => FilePath -> IO (Either ParseException [a]) Source #
Like decodeFileEither, but decode multiple documents.
Since: 0.11.5.0
decodeAllFileWithWarnings :: FromJSON a => FilePath -> IO (Either ParseException ([Warning], [a])) Source #
Like decodeFileWithWarnings, but decode multiple documents.
Since: 0.11.5.0
decodeAllThrow :: (MonadThrow m, FromJSON a) => ByteString -> m [a] Source #
Like decodeThrow, but decode multiple documents.
Since: 0.11.5.0
decodeAllFileThrow :: (MonadIO m, FromJSON a) => FilePath -> m [a] Source #
Like decodeFileThrow, but decode multiple documents.
Since: 0.11.5.0
More control over decoding
decodeHelper :: FromJSON a => ConduitM () Event Parse () -> IO (Either ParseException ([Warning], Either String a)) Source #
Types
A JSON value represented as a Haskell value.
Instances
| Arbitrary Value | Since: aeson-2.0.3.0 |
| CoArbitrary Value | Since: aeson-2.0.3.0 |
Defined in Data.Aeson.Types.Internal | |
| Function Value | Since: aeson-2.0.3.0 |
| FromJSON Value | |
| FromString Encoding | |
Defined in Data.Aeson.Types.ToJSON Methods fromString :: String -> Encoding | |
| FromString Value | |
Defined in Data.Aeson.Types.ToJSON Methods fromString :: String -> Value | |
| ToJSON Value | |
| Data Value | |
Defined in Data.Aeson.Types.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value # dataTypeOf :: Value -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) # gmapT :: (forall b. Data b => b -> b) -> Value -> Value # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value # | |
| IsString Value | |
Defined in Data.Aeson.Types.Internal Methods fromString :: String -> Value # | |
| Generic Value | |
| Read Value | |
| Show Value | Since version 1.5.6.0 version object values are printed in lexicographic key order
|
| NFData Value | |
Defined in Data.Aeson.Types.Internal | |
| Eq Value | |
| Ord Value | The ordering is total, consistent with Since: aeson-1.5.2.0 |
| Hashable Value | |
| Lift Value | Since: aeson-0.11.0.0 |
| (GToJSON' Encoding arity a, ConsToJSON Encoding arity a, Constructor c) => SumToJSON' TwoElemArray Encoding arity (C1 c a) | |
Defined in Data.Aeson.Types.ToJSON | |
| (GToJSON' Value arity a, ConsToJSON Value arity a, Constructor c) => SumToJSON' TwoElemArray Value arity (C1 c a) | |
Defined in Data.Aeson.Types.ToJSON | |
| GToJSON' Encoding arity (U1 :: Type -> Type) | |
| GToJSON' Encoding arity (V1 :: Type -> Type) | |
| GToJSON' Value arity (U1 :: Type -> Type) | |
| GToJSON' Value arity (V1 :: Type -> Type) | |
| ToJSON1 f => GToJSON' Encoding One (Rec1 f) | |
| ToJSON1 f => GToJSON' Value One (Rec1 f) | |
| (EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b) | |
| ToJSON a => GToJSON' Encoding arity (K1 i a :: Type -> Type) | |
| (WriteProduct arity a, WriteProduct arity b, ProductSize a, ProductSize b) => GToJSON' Value arity (a :*: b) | |
| ToJSON a => GToJSON' Value arity (K1 i a :: Type -> Type) | |
| (ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g) | |
| (ToJSON1 f, GToJSON' Value One g) => GToJSON' Value One (f :.: g) | |
| FromPairs Value (DList Pair) | |
Defined in Data.Aeson.Types.ToJSON | |
| v ~ Value => KeyValuePair v (DList Pair) | |
Defined in Data.Aeson.Types.ToJSON | |
| type Rep Value | |
Defined in Data.Aeson.Types.Internal type Rep Value = D1 ('MetaData "Value" "Data.Aeson.Types.Internal" "aeson-2.1.2.1-9jEhZ2A8AhR5FZtDn0mBSx" 'False) ((C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Object)) :+: (C1 ('MetaCons "Array" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Array)) :+: C1 ('MetaCons "String" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "Bool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "Null" 'PrefixI 'False) (U1 :: Type -> Type)))) | |
A JSON parser. N.B. This might not fit your usual understanding of
"parser". Instead you might like to think of Parser as a "parse result",
i.e. a parser to which the input has already been applied.
Instances
| MonadFail Parser | |
Defined in Data.Aeson.Types.Internal | |
| MonadFix Parser | Since: aeson-2.1.0.0 |
Defined in Data.Aeson.Types.Internal | |
| Alternative Parser | |
| Applicative Parser | |
| Functor Parser | |
| Monad Parser | |
| MonadPlus Parser | |
| Monoid (Parser a) | |
| Semigroup (Parser a) | |
data ParseException Source #
Constructors
Instances
| Exception ParseException Source # | |
Defined in Data.Yaml.Internal Methods toException :: ParseException -> SomeException # | |
| Show ParseException Source # | |
Defined in Data.Yaml.Internal Methods showsPrec :: Int -> ParseException -> ShowS # show :: ParseException -> String # showList :: [ParseException] -> ShowS # | |
prettyPrintParseException :: ParseException -> String Source #
Alternative to show to display a ParseException on the screen.
Instead of displaying the data constructors applied to their arguments,
a more textual output is returned. For example, instead of printing:
InvalidYaml (Just (YamlParseException {yamlProblem = "did not find expected ',' or '}'", yamlContext = "while parsing a flow mapping", yamlProblemMark = YamlMark {yamlIndex = 42, yamlLine = 2, yamlColumn = 12}})))It looks more pleasant to print:
YAML parse exception at line 2, column 12, while parsing a flow mapping: did not find expected ',' or '}'
Since 0.8.11
data YamlException Source #
Constructors
| YamlException String | |
| YamlParseException | problem, context, index, position line, position column |
Fields | |
Instances
| Exception YamlException | |
Defined in Text.Libyaml Methods toException :: YamlException -> SomeException # fromException :: SomeException -> Maybe YamlException # displayException :: YamlException -> String # | |
| Show YamlException | |
Defined in Text.Libyaml Methods showsPrec :: Int -> YamlException -> ShowS # show :: YamlException -> String # showList :: [YamlException] -> ShowS # | |
The pointer position
Constructors and accessors
(.:) :: FromJSON a => Object -> Key -> Parser a Source #
Retrieve the value associated with the given key of an Object.
The result is empty if the key is not present or the value cannot
be converted to the desired type.
This accessor is appropriate if the key and value must be present
in an object for it to be valid. If the key and value are
optional, use .:? instead.
(.:?) :: FromJSON a => Object -> Key -> Parser (Maybe a) Source #
Retrieve the value associated with the given key of an Object. The
result is Nothing if the key is not present or if its value is Null,
or empty if the value cannot be converted to the desired type.
This accessor is most useful if the key and value can be absent
from an object without affecting its validity. If the key and
value are mandatory, use .: instead.
(.!=) :: Parser (Maybe a) -> a -> Parser a Source #
Helper for use in combination with .:? to provide default
values for optional JSON object fields.
This combinator is most useful if the key and value can be absent
from an object without affecting its validity and we know a default
value to assign in that case. If the key and value are mandatory,
use .: instead.
Example usage:
v1 <- o.:?"opt_field_with_dfl" .!= "default_val" v2 <- o.:"mandatory_field" v3 <- o.:?"opt_field2"
With helpers (since 0.8.23)
withObject :: String -> (Object -> Parser a) -> Value -> Parser a Source #
withObject name f valuef to the Object when value
is an Object and fails otherwise.
Error message example
withObject "MyType" f (String "oops") -- Error: "parsing MyType failed, expected Object, but encountered String"
withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a Source #
withScientific name f valuef to the Scientific number
when value is a Number and fails using typeMismatch
otherwise.
Warning: If you are converting from a scientific to an unbounded
type such as Integer you may want to add a restriction on the
size of the exponent (see withBoundedScientific) to prevent
malicious input from filling up the memory of the target system.
Error message example
withScientific "MyType" f (String "oops") -- Error: "parsing MyType failed, expected Number, but encountered String"
Parsing
parseMonad :: MonadFail m => (a -> Parser b) -> a -> m b Source #
Deprecated: With the MonadFail split, this function is going to be removed in the future. Please migrate to parseEither.
Classes
A type that can be converted to JSON.
Instances in general must specify toJSON and should (but don't need
to) specify toEncoding.
An example type and instance:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceToJSONCoord wheretoJSON(Coord x y) =object["x".=x, "y".=y]toEncoding(Coord x y) =pairs("x".=x<>"y".=y)
Instead of manually writing your ToJSON instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
- The compiler can provide a default generic implementation for
toJSON.
To use the second, simply add a deriving clause to your
datatype and declare a GenericToJSON instance. If you require nothing other than
defaultOptions, it is sufficient to write (and this is the only
alternative where the default toJSON implementation is sufficient):
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance ToJSON Coord where
toEncoding = genericToEncoding defaultOptions
or more conveniently using the DerivingVia extension
deriving viaGenericallyCoord instanceToJSONCoord
If on the other hand you wish to customize the generic decoding, you have to implement both methods:
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceToJSONCoord wheretoJSON=genericToJSONcustomOptionstoEncoding=genericToEncodingcustomOptions
Previous versions of this library only had the toJSON method. Adding
toEncoding had two reasons:
toEncodingis more efficient for the common case that the output oftoJSONis directly serialized to aByteString. Further, expressing either method in terms of the other would be non-optimal.- The choice of defaults allows a smooth transition for existing users:
Existing instances that do not define
toEncodingstill compile and have the correct semantics. This is ensured by making the default implementation oftoEncodingusetoJSON. This produces correct results, but since it performs an intermediate conversion to aValue, it will be less efficient than directly emitting anEncoding. (this also means that specifying nothing more thaninstance ToJSON Coordwould be sufficient as a generically decoding instance, but there probably exists no good reason to not specifytoEncodingin new instances.)
Minimal complete definition
Nothing
Methods
Convert a Haskell value to a JSON-friendly intermediate type.
toEncoding :: a -> Encoding Source #
Encode a Haskell value as JSON.
The default implementation of this method creates an
intermediate Value using toJSON. This provides
source-level compatibility for people upgrading from older
versions of this library, but obviously offers no performance
advantage.
To benefit from direct encoding, you must provide an
implementation for this method. The easiest way to do so is by
having your types implement Generic using the DeriveGeneric
extension, and then have GHC generate a method body as follows.
instanceToJSONCoord wheretoEncoding=genericToEncodingdefaultOptions
toJSONList :: [a] -> Value Source #
toEncodingList :: [a] -> Encoding Source #
Instances
class FromJSON a where Source #
A type that can be converted from JSON, with the possibility of failure.
In many cases, you can get the compiler to generate parsing code for you (see below). To begin, let's cover writing an instance by hand.
There are various reasons a conversion could fail. For example, an
Object could be missing a required key, an Array could be of
the wrong size, or a value could be of an incompatible type.
The basic ways to signal a failed conversion are as follows:
failyields a custom error message: it is the recommended way of reporting a failure;empty(ormzero) is uninformative: use it when the error is meant to be caught by some(;<|>)typeMismatchcan be used to report a failure when the encountered value is not of the expected JSON type;unexpectedis an appropriate alternative when more than one type may be expected, or to keep the expected type implicit.
prependFailure (or modifyFailure) add more information to a parser's
error messages.
An example type and instance using typeMismatch and prependFailure:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceFromJSONCoord whereparseJSON(Objectv) = Coord<$>v.:"x"<*>v.:"y" -- We do not expect a non-Objectvalue here. -- We could useemptyto fail, buttypeMismatch-- gives a much more informative error message.parseJSONinvalid =prependFailure"parsing Coord failed, " (typeMismatch"Object" invalid)
For this common case of only being concerned with a single
type of JSON value, the functions withObject, withScientific, etc.
are provided. Their use is to be preferred when possible, since
they are more terse. Using withObject, we can rewrite the above instance
(assuming the same language extension and data type) as:
instanceFromJSONCoord whereparseJSON=withObject"Coord" $ \v -> Coord<$>v.:"x"<*>v.:"y"
Instead of manually writing your FromJSON instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
- The compiler can provide a default generic implementation for
parseJSON.
To use the second, simply add a deriving clause to your
datatype and declare a GenericFromJSON instance for your datatype without giving
a definition for parseJSON.
For example, the previous example can be simplified to just:
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance FromJSON Coord
or using the DerivingVia extension
deriving viaGenericallyCoord instanceFromJSONCoord
The default implementation will be equivalent to
parseJSON = ; if you need different
options, you can customize the generic decoding by defining:genericParseJSON defaultOptions
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceFromJSONCoord whereparseJSON=genericParseJSONcustomOptions
Minimal complete definition
Nothing
Instances
Custom encoding
isSpecialString :: Text -> Bool Source #
Determine whether a string must be quoted in YAML and can't appear as plain text.
Useful if you want to use setStringStyle.
Since: 0.10.2.0
data EncodeOptions Source #
Since: 0.10.2.0
defaultEncodeOptions :: EncodeOptions Source #
Since: 0.10.2.0
defaultStringStyle :: StringStyle Source #
Since: 0.11.2.0
setStringStyle :: (Text -> (Tag, Style)) -> EncodeOptions -> EncodeOptions Source #
Set the string style in the encoded YAML. This is a function that decides for each string the type of YAML string to output.
WARNING: You must ensure that special strings (like "yes"/"no"/"null"/"1234") are not encoded with the Plain style, because
then they will be decoded as boolean, null or numeric values. You can use isSpecialString to detect them.
By default, strings are encoded as follows:
- Any string containing a newline character uses the
Literalstyle - Otherwise, any special string (see
isSpecialString) usesSingleQuoted - Otherwise, use
Plain
Since: 0.10.2.0
setFormat :: FormatOptions -> EncodeOptions -> EncodeOptions Source #
Set the encoding formatting for the encoded YAML. By default, this is defaultFormatOptions.
Since: 0.10.2.0
data FormatOptions Source #
Contains options relating to the formatting (indendation, width) of the YAML output.
Since: libyaml-0.10.2.0
defaultFormatOptions :: FormatOptions Source #
Since: libyaml-0.10.2.0
setWidth :: Maybe Int -> FormatOptions -> FormatOptions Source #
Set the maximum number of columns in the YAML output, or Nothing for infinite. By default, the limit is 80 characters.
Since: libyaml-0.10.2.0
Deprecated
decode :: FromJSON a => ByteString -> Maybe a Source #
Deprecated: Please use decodeEither or decodeThrow, which provide information on how the decode failed
decodeFile :: FromJSON a => FilePath -> IO (Maybe a) Source #
Deprecated: Please use decodeFileEither, which does not confused type-directed and runtime exceptions.
decodeEither :: FromJSON a => ByteString -> Either String a Source #
Deprecated: Please use decodeEither' or decodeThrow, which provide more useful failures