Safe Haskell	None
Language	Haskell98

Text.Libyaml

Contents

The event stream
Encoding and decoding
Error handling

Description

Low-level, streaming YAML interface. For a higher-level interface, see Data.Yaml.

Synopsis

The event stream

data Event Source #

Constructors

EventStreamStart
EventStreamEnd
EventDocumentStart
EventDocumentEnd
EventAlias !AnchorName
EventScalar !ByteString !Tag !Style !Anchor
EventSequenceStart !Anchor
EventSequenceEnd
EventMappingStart !Anchor
EventMappingEnd

Instances

Eq Event Source #
Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Show Event Source #
Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #

data Style Source #

Constructors

Any
Plain
SingleQuoted
DoubleQuoted
Literal
Folded
PlainNoTag

Instances

Bounded Style Source #
Methods minBound :: Style # maxBound :: Style #
Enum Style Source #
Methods succ :: Style -> Style # pred :: Style -> Style # toEnum :: Int -> Style # fromEnum :: Style -> Int # enumFrom :: Style -> [Style] # enumFromThen :: Style -> Style -> [Style] # enumFromTo :: Style -> Style -> [Style] # enumFromThenTo :: Style -> Style -> Style -> [Style] #
Eq Style Source #
Methods (==) :: Style -> Style -> Bool # (/=) :: Style -> Style -> Bool #
Data Style Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Style -> c Style # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Style # toConstr :: Style -> Constr # dataTypeOf :: Style -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Style) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Style) # gmapT :: (forall b. Data b => b -> b) -> Style -> Style # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r # gmapQ :: (forall d. Data d => d -> u) -> Style -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Style -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Style -> m Style # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style #
Ord Style Source #
Methods compare :: Style -> Style -> Ordering # (<) :: Style -> Style -> Bool # (<=) :: Style -> Style -> Bool # (>) :: Style -> Style -> Bool # (>=) :: Style -> Style -> Bool # max :: Style -> Style -> Style # min :: Style -> Style -> Style #
Read Style Source #
Methods readsPrec :: Int -> ReadS Style # readList :: ReadS [Style] # readPrec :: ReadPrec Style # readListPrec :: ReadPrec [Style] #
Show Style Source #
Methods showsPrec :: Int -> Style -> ShowS # show :: Style -> String # showList :: [Style] -> ShowS #

data Tag Source #

Constructors

StrTag
FloatTag
NullTag
BoolTag
SetTag
IntTag
SeqTag
MapTag
UriTag String
NoTag

Instances

Eq Tag Source #
Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Data Tag Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # toConstr :: Tag -> Constr # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #
Read Tag Source #
Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #

type AnchorName = String Source #

type Anchor = Maybe AnchorName Source #

Encoding and decoding

encode :: MonadResource m => ConduitM Event o m ByteString Source #

decode :: MonadResource m => ByteString -> ConduitM i Event m () Source #

encodeFile :: MonadResource m => FilePath -> ConduitM Event o m () Source #

decodeFile :: MonadResource m => FilePath -> ConduitM i Event m () Source #

Error handling

data YamlException Source #

Constructors

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

Instances

Show YamlException Source #
Methods showsPrec :: Int -> YamlException -> ShowS # show :: YamlException -> String # showList :: [YamlException] -> ShowS #
Exception YamlException Source #
Methods toException :: YamlException -> SomeException # fromException :: SomeException -> Maybe YamlException # displayException :: YamlException -> String #

data YamlMark Source #

The pointer position

Constructors

YamlMark
Fields yamlIndex :: Int yamlLine :: Int yamlColumn :: Int

Instances

Show YamlMark Source #
Methods showsPrec :: Int -> YamlMark -> ShowS # show :: YamlMark -> String # showList :: [YamlMark] -> ShowS #