| Safe Haskell | None |
|---|
Text.Libyaml
Description
Low-level, streaming YAML interface. For a higher-level interface, see Data.Yaml.
- data Event
- = EventStreamStart
- | EventStreamEnd
- | EventDocumentStart
- | EventDocumentEnd
- | EventAlias !AnchorName
- | EventScalar !ByteString !Tag !Style !Anchor
- | EventSequenceStart !Anchor
- | EventSequenceEnd
- | EventMappingStart !Anchor
- | EventMappingEnd
- data Style
- = Any
- | Plain
- | SingleQuoted
- | DoubleQuoted
- | Literal
- | Folded
- | PlainNoTag
- data Tag
- type AnchorName = String
- type Anchor = Maybe AnchorName
- encode :: MonadResource m => Consumer Event m ByteString
- decode :: MonadResource m => ByteString -> Producer m Event
- encodeFile :: MonadResource m => FilePath -> Consumer Event m ()
- decodeFile :: MonadResource m => FilePath -> Producer m Event
- data YamlException
- = YamlException String
- | YamlParseException {
- yamlProblem :: String
- yamlContext :: String
- yamlProblemMark :: YamlMark
- data YamlMark = YamlMark {
- yamlIndex :: Int
- yamlLine :: Int
- yamlColumn :: Int
The event stream
data Event
data Style
Constructors
| Any | |
| Plain | |
| SingleQuoted | |
| DoubleQuoted | |
| Literal | |
| Folded | |
| PlainNoTag |
data Tag
type AnchorName = String
type Anchor = Maybe AnchorName
Encoding and decoding
encodeFile :: MonadResource m => FilePath -> Consumer Event m ()
decodeFile :: MonadResource m => FilePath -> Producer m Event
Error handling
data YamlException
Constructors
| YamlException String | |
| YamlParseException | problem, context, index, position line, position column |
Fields
| |
Instances
| Show YamlException | |
| Typeable YamlException | |
| Exception YamlException |