yaml-marked-0.2.0.1: Support for parsing and rendering YAML documents with marks.

Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Yaml.Marked.Decode

Contents

Exceptions

Synopsis

decodeThrow :: MonadThrow m => (Marked Value -> Either String a) -> FilePath -> ByteString -> m a
decodeAllThrow :: MonadThrow m => (Marked Value -> Either String a) -> FilePath -> ByteString -> m [a]
decodeFileEither :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException a)
decodeAllFileEither :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException [a])
decodeFileWithWarnings :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException (a, [Warning]))
decodeAllFileWithWarnings :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException ([a], [Warning]))
data ParseException
- = NonScalarKey
- | UnknownAlias {
  - _anchorName :: AnchorName
  }
- | UnexpectedEvent {
  - _received :: Maybe Event
  - _expected :: Maybe Event
  }
- | InvalidYaml (Maybe YamlException)
- | MultipleDocuments
- | AesonException String
- | OtherParseException SomeException
- | NonStringKey JSONPath
- | NonStringKeyAlias AnchorName Value
- | CyclicIncludes
- | LoadSettingsException FilePath ParseException
data YamlException
- = YamlException String
- | YamlParseException {
  - yamlProblem :: String
  - yamlContext :: String
  - yamlProblemMark :: YamlMark
  }

Documentation

decodeThrow Source #

Arguments

:: MonadThrow m
=> (Marked Value -> Either String a)
-> FilePath	Name of input being parsed
-> ByteString
-> m a

decodeAllThrow Source #

Arguments

:: MonadThrow m
=> (Marked Value -> Either String a)
-> FilePath	Name of input being parsed
-> ByteString
-> m [a]

decodeFileEither :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException a) Source #

decodeAllFileEither :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException [a]) Source #

decodeFileWithWarnings :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException (a, [Warning])) Source #

decodeAllFileWithWarnings :: MonadIO m => (Marked Value -> Either String a) -> FilePath -> m (Either ParseException ([a], [Warning])) Source #

Exceptions

data ParseException #

Instances

Instances details

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

data YamlException #

Constructors

YamlException String
YamlParseException	problem, context, index, position line, position column
Fields yamlProblem :: String yamlContext :: String yamlProblemMark :: YamlMark

Instances

Instances details

Exception YamlException
Instance details Defined in Text.Libyaml Methods toException :: YamlException -> SomeException # fromException :: SomeException -> Maybe YamlException # displayException :: YamlException -> String #
Show YamlException
Instance details Defined in Text.Libyaml Methods showsPrec :: Int -> YamlException -> ShowS # show :: YamlException -> String # showList :: [YamlException] -> ShowS #