data-object-yaml-0.3.1: Serialize data to and from Yaml files Source code Contents Index

Data.Object.Yaml

Contents Definition of YamlObject Automatic scalar conversions Encoding/decoding Exceptions

Synopsis

data YamlScalar = YamlScalar { value :: ByteString tag :: Tag style :: Style } type YamlObject = Object YamlScalar YamlScalar class Eq a => IsYamlScalar a where fromYamlScalar :: YamlScalar -> a toYamlScalar :: a -> YamlScalar toYamlObject :: IsYamlScalar k => IsYamlScalar v => Object k v -> YamlObject fromYamlObject :: IsYamlScalar k => IsYamlScalar v => YamlObject -> Object k v encode :: (IsYamlScalar k, IsYamlScalar v) => Object k v -> ByteString encodeFile :: (IsYamlScalar k, IsYamlScalar v) => FilePath -> Object k v -> IO () decode :: (Failure ParseException m, IsYamlScalar k, IsYamlScalar v) => ByteString -> m (Object k v) decodeFile :: (Failure ParseException m, IsYamlScalar k, IsYamlScalar v) => FilePath -> IO (m (Object k v)) data ParseException = NonScalarKey | UnknownAlias { _anchorName :: AnchorName } | UnexpectedEvent { _received :: Maybe Event _expected :: Maybe Event } | InvalidYaml (Maybe ErrMsg)

Definition of YamlObject

data YamlScalar Source

Equality depends on value and tag, not style. Constructors YamlScalar value :: ByteString tag :: Tag style :: Style Instances Eq YamlScalar Data YamlScalar Read YamlScalar Show YamlScalar Typeable YamlScalar IsYamlScalar YamlScalar

type YamlObject = Object YamlScalar YamlScalar Source

Automatic scalar conversions

class Eq a => IsYamlScalar a where Source

Methods fromYamlScalar :: YamlScalar -> a Source toYamlScalar :: a -> YamlScalar Source Instances IsYamlScalar ByteString IsYamlScalar ByteString IsYamlScalar Text IsYamlScalar Text IsYamlScalar YamlScalar IsYamlScalar [Char]

toYamlObject :: IsYamlScalar k => IsYamlScalar v => Object k v -> YamlObject Source

fromYamlObject :: IsYamlScalar k => IsYamlScalar v => YamlObject -> Object k v Source

Encoding/decoding

encode :: (IsYamlScalar k, IsYamlScalar v) => Object k v -> ByteString Source

encodeFile :: (IsYamlScalar k, IsYamlScalar v) => FilePath -> Object k v -> IO () Source

decode :: (Failure ParseException m, IsYamlScalar k, IsYamlScalar v) => ByteString -> m (Object k v) Source

decodeFile :: (Failure ParseException m, IsYamlScalar k, IsYamlScalar v) => FilePath -> IO (m (Object k v)) Source

Exceptions

data ParseException Source

Constructors NonScalarKey UnknownAlias _anchorName :: AnchorName UnexpectedEvent _received :: Maybe Event _expected :: Maybe Event InvalidYaml (Maybe ErrMsg) Instances Show ParseException Typeable ParseException Exception ParseException

Produced by Haddock version 2.6.1