Safe Haskell	None
Language	Haskell2010

Data.Yaml.Parser

Description

NOTE: This module is a highly experimental preview release. It may change drastically, or be entirely removed, in a future release.

Documentation

newtype YamlParser a Source #

Constructors

YamlParser
Fields unYamlParser :: AnchorMap -> Either Text a

Instances

Monad YamlParser Source #
Instance details Defined in Data.Yaml.Parser Methods (>>=) :: YamlParser a -> (a -> YamlParser b) -> YamlParser b # (>>) :: YamlParser a -> YamlParser b -> YamlParser b # return :: a -> YamlParser a # fail :: String -> YamlParser a #
Functor YamlParser Source #
Instance details Defined in Data.Yaml.Parser Methods fmap :: (a -> b) -> YamlParser a -> YamlParser b # (<$) :: a -> YamlParser b -> YamlParser a #
Applicative YamlParser Source #
Instance details Defined in Data.Yaml.Parser Methods pure :: a -> YamlParser a # (<>) :: YamlParser (a -> b) -> YamlParser a -> YamlParser b # liftA2 :: (a -> b -> c) -> YamlParser a -> YamlParser b -> YamlParser c # (>) :: YamlParser a -> YamlParser b -> YamlParser b # (<*) :: YamlParser a -> YamlParser b -> YamlParser a #
Alternative YamlParser Source #
Instance details Defined in Data.Yaml.Parser Methods empty :: YamlParser a # (<\|>) :: YamlParser a -> YamlParser a -> YamlParser a # some :: YamlParser a -> YamlParser [a] # many :: YamlParser a -> YamlParser [a] #
MonadPlus YamlParser Source #
Instance details Defined in Data.Yaml.Parser Methods mzero :: YamlParser a # mplus :: YamlParser a -> YamlParser a -> YamlParser a #
Semigroup (YamlParser a) Source #
Instance details Defined in Data.Yaml.Parser Methods (<>) :: YamlParser a -> YamlParser a -> YamlParser a # sconcat :: NonEmpty (YamlParser a) -> YamlParser a # stimes :: Integral b => b -> YamlParser a -> YamlParser a #
Monoid (YamlParser a) Source #
Instance details Defined in Data.Yaml.Parser Methods mempty :: YamlParser a # mappend :: YamlParser a -> YamlParser a -> YamlParser a # mconcat :: [YamlParser a] -> YamlParser a #

lookupAnchor :: AnchorName -> YamlParser (Maybe YamlValue) Source #

withAnchor :: AnchorName -> Text -> (YamlValue -> YamlParser a) -> YamlParser a Source #

withMapping :: Text -> ([(Text, YamlValue)] -> YamlParser a) -> YamlValue -> YamlParser a Source #

withSequence :: Text -> ([YamlValue] -> YamlParser a) -> YamlValue -> YamlParser a Source #

withText :: Text -> (Text -> YamlParser a) -> YamlValue -> YamlParser a Source #

typeMismatch :: Text -> YamlValue -> YamlParser a Source #

class FromYaml a where Source #

Minimal complete definition

fromYaml

Methods

fromYaml :: YamlValue -> YamlParser a Source #

Instances

FromYaml Int Source #
Instance details Defined in Data.Yaml.Parser Methods fromYaml :: YamlValue -> YamlParser Int Source #
FromYaml Text Source #
Instance details Defined in Data.Yaml.Parser Methods fromYaml :: YamlValue -> YamlParser Text Source #
FromYaml YamlValue Source #
Instance details Defined in Data.Yaml.Parser Methods fromYaml :: YamlValue -> YamlParser YamlValue Source #
FromYaml a => FromYaml [a] Source #
Instance details Defined in Data.Yaml.Parser Methods fromYaml :: YamlValue -> YamlParser [a] Source #

data YamlValue Source #

Constructors

Mapping [(Text, YamlValue)] Anchor
Sequence [YamlValue] Anchor
Scalar ByteString Tag Style Anchor
Alias AnchorName

Instances

Show YamlValue Source #
Instance details Defined in Data.Yaml.Parser Methods showsPrec :: Int -> YamlValue -> ShowS # show :: YamlValue -> String # showList :: [YamlValue] -> ShowS #
FromYaml YamlValue Source #
Instance details Defined in Data.Yaml.Parser Methods fromYaml :: YamlValue -> YamlParser YamlValue Source #

type AnchorMap = Map AnchorName YamlValue Source #

data RawDoc Source #

Constructors

RawDoc YamlValue AnchorMap

Instances

Show RawDoc Source #
Instance details Defined in Data.Yaml.Parser Methods showsPrec :: Int -> RawDoc -> ShowS # show :: RawDoc -> String # showList :: [RawDoc] -> ShowS #

parseRawDoc :: (FromYaml a, MonadThrow m) => RawDoc -> m a Source #

(.:) :: FromYaml a => [(Text, YamlValue)] -> Text -> YamlParser a Source #

data YamlParseException Source #

Constructors

UnexpectedEndOfEvents
UnexpectedEvent Event
FromYamlException Text

Instances

Show YamlParseException Source #
Instance details Defined in Data.Yaml.Parser Methods showsPrec :: Int -> YamlParseException -> ShowS # show :: YamlParseException -> String # showList :: [YamlParseException] -> ShowS #
Exception YamlParseException Source #
Instance details Defined in Data.Yaml.Parser Methods toException :: YamlParseException -> SomeException # fromException :: SomeException -> Maybe YamlParseException # displayException :: YamlParseException -> String #

sinkValue :: MonadThrow m => ConduitM Event o (WriterT AnchorMap m) YamlValue Source #

sinkRawDoc :: MonadThrow m => ConduitM Event o m RawDoc Source #

readYamlFile :: FromYaml a => FilePath -> IO a Source #