yaml-0.2.0: Low-level binding to the libyaml C library. Source code Contents Index

Text.Libyaml

Contents The event stream Exceptions Enumerator Encoder Higher level functions

Synopsis

data Event = EventNone | EventStreamStart | EventStreamEnd | EventDocumentStart | EventDocumentEnd | EventAlias | EventScalar !ByteString !Tag !Style | EventSequenceStart | EventSequenceEnd | EventMappingStart | EventMappingEnd data Style = Any | Plain | SingleQuoted | DoubleQuoted | Literal | Folded data Tag = StrTag | FloatTag | NullTag | BoolTag | SetTag | IntTag | SeqTag | MapTag | UriTag String | NoTag data YamlException = YamlParserException { parserProblem :: String parserContext :: String parserOffset :: Int } | YamlEmitterException { emitterEvent :: Event emitterProblem :: String } | YamlOutOfMemory | YamlInvalidEventStreamBeginning [Event] | YamlInvalidEventStreamEnd [Event] | YamlPrematureEventStreamEnd | YamlNonScalarKey | YamlInvalidStartingEvent Event | YamlFileNotFound FilePath | YamlOtherException SomeException | YamlStringException String class MonadIO m => With m where with :: (forall b'. (a -> IO b') -> IO b') -> (a -> m b) -> m b type YamlEncoder = ReaderT Emitter type YamlDecoder = ReaderT Parser parseEvent :: (With m, MonadFailure YamlException m) => YamlDecoder m Event emitEvent :: (MonadIO m, MonadFailure YamlException m) => Event -> YamlEncoder m () encode :: (With m, MonadFailure YamlException m) => YamlEncoder m () -> m ByteString decode :: (With m, MonadFailure YamlException m) => ByteString -> YamlDecoder m a -> m a encodeFile :: (With m, MonadFailure YamlException m) => FilePath -> YamlEncoder m () -> m () decodeFile :: (With m, MonadFailure YamlException m) => FilePath -> YamlDecoder m a -> m a

The event stream

data Event Source

Constructors EventNone EventStreamStart EventStreamEnd EventDocumentStart EventDocumentEnd EventAlias EventScalar !ByteString !Tag !Style EventSequenceStart EventSequenceEnd EventMappingStart EventMappingEnd Instances Eq Event Show Event

data Style Source

Constructors Any Plain SingleQuoted DoubleQuoted Literal Folded Instances Bounded Style Enum Style Eq Style Ord Style Show Style

data Tag Source

Constructors StrTag FloatTag NullTag BoolTag SetTag IntTag SeqTag MapTag UriTag String NoTag Instances Eq Tag Show Tag

Exceptions

data YamlException Source

Constructors YamlParserException parserProblem :: String parserContext :: String parserOffset :: Int YamlEmitterException emitterEvent :: Event emitterProblem :: String YamlOutOfMemory YamlInvalidEventStreamBeginning [Event] YamlInvalidEventStreamEnd [Event] YamlPrematureEventStreamEnd YamlNonScalarKey YamlInvalidStartingEvent Event YamlFileNotFound FilePath YamlOtherException SomeException YamlStringException String Instances Show YamlException Typeable YamlException Exception YamlException Error YamlException

Enumerator

class MonadIO m => With m where Source

Methods with :: (forall b'. (a -> IO b') -> IO b') -> (a -> m b) -> m b Source Instances With IO With m => With (ReaderT r m) (Error e, With m) => With (ErrorT e m)

Encoder

type YamlEncoder = ReaderT Emitter Source

type YamlDecoder = ReaderT Parser Source

parseEvent :: (With m, MonadFailure YamlException m) => YamlDecoder m Event Source

emitEvent :: (MonadIO m, MonadFailure YamlException m) => Event -> YamlEncoder m () Source

Higher level functions

encode :: (With m, MonadFailure YamlException m) => YamlEncoder m () -> m ByteString Source

decode :: (With m, MonadFailure YamlException m) => ByteString -> YamlDecoder m a -> m a Source

encodeFile :: (With m, MonadFailure YamlException m) => FilePath -> YamlEncoder m () -> m () Source

decodeFile :: (With m, MonadFailure YamlException m) => FilePath -> YamlDecoder m a -> m a Source

Produced by Haddock version 2.6.1