Text.JSON.YAJL

Parser

data Parser m

data ParseStatus

Constructors

ParseFinished

ParseContinue

More input is required before parsing can complete.

ParseCancelled

A callback returned False.

ParseError Text

An error occured while parsing. The included message contains details about the error.

Instances

Eq ParseStatus

Show ParseStatus

newParserIO :: IO (Parser IO)

newParserST :: ST s (Parser (ST s))

Parser callbacks

data Callback m a

A callback should return True to continue parsing, or False to cancel.

setCallback :: Parser m -> Callback m a -> a -> m ()

clearCallback :: Parser m -> Callback m a -> m ()

Containers

parsedBeginArray :: Callback m (m Bool)

parsedEndArray :: Callback m (m Bool)

parsedBeginObject :: Callback m (m Bool)

parsedEndObject :: Callback m (m Bool)

Basic values

parsedNull :: Callback m (m Bool)

parsedBoolean :: Callback m (Bool -> m Bool)

Numeric callbacks

parsedInteger :: Callback m (Integer -> m Bool)

parsedDouble :: Callback m (Double -> m Bool)

parsedNumber :: Callback m (ByteString -> m Bool)

If parsedNumber is set, it overrides parsedInteger and parsedDouble. Registered functions for these callbacks will not receive any input until parsedNumber is unset.

If parsedNumber is not set, but one of parsedInteger or parsedDouble is set, then any values which cannot be represented by CLong or CDouble will cause a parse error.

The ByteString is in UTF-8.

Text callbacks

parsedAttributeText :: Callback m (Text -> m Bool)

Only one of parsedAttributeText, parsedAttributeBytes, or parsedAttributeBuffer may be set. If another of these callbacks is set, it will unset the others.

parsedAttributeBytes :: Callback m (ByteString -> m Bool)

Only one of parsedAttributeText, parsedAttributeBytes, or parsedAttributeBuffer may be set. If another of these callbacks is set, it will unset the others.

The ByteString is in UTF-8.

parsedAttributeBuffer :: Callback m ((Ptr Word8, Integer) -> m Bool)

Only one of parsedAttributeText, parsedAttributeBytes, or parsedAttributeBuffer may be set. If another of these callbacks is set, it will unset the others.

The buffer is in UTF-8.

parsedText :: Callback m (Text -> m Bool)

Only one of parsedText, parsedBytes, or parsedBuffer may be set. If another of these callbacks is set, it will unset the others.

parsedBytes :: Callback m (ByteString -> m Bool)

Only one of parsedText, parsedBytes, or parsedBuffer may be set. If another of these callbacks is set, it will unset the others.

The ByteString is in UTF-8.

parsedBuffer :: Callback m ((Ptr Word8, Integer) -> m Bool)

Only one of parsedText, parsedBytes, or parsedBuffer may be set. If another of these callbacks is set, it will unset the others.

The buffer is in UTF-8.

Parser input

parseText :: Parser m -> Text -> m ParseStatus

parseLazyText :: Parser m -> Text -> m ParseStatus

parseBytes :: Parser m -> ByteString -> m ParseStatus

The input must be in UTF-8.

parseLazyBytes :: Parser m -> ByteString -> m ParseStatus

The input must be in UTF-8.

parseBuffer :: Parser m -> (Ptr Word8, Integer) -> m ParseStatus

The input must be in UTF-8.

parseComplete :: Parser m -> m ParseStatus

Clients should call this when no more input is available, to indicate EOF.

getBytesConsumed :: Parser m -> m Integer

Get the number of bytes consumed from the last input chunk.

Note that if using parseText or parseLazyText, this corresponds to UTF-8 bytes, not characters.

If the most recent call to parseBytes, parseText, etc, returned ParseFinished, this will indicate whether there are any un-parsed bytes past the end of input.

If the most recent parse returned ParseError, this will indicate where the error occured.

Generator

data Generator s

data GeneratorConfig

Constructors

GeneratorConfig

Fields

generatorBeautify :: Bool

Whether to generate indented, whitespaced output.

generatorIndent :: Text

How much to indent beautified output by. This is only used if generatorBeautify is True.

data GeneratorError

If an error is encountered when generating data, a GeneratorError will be thrown.

With the exception of MaximumDepthExceeded, this is usually due to incorrect use of the library.

Constructors

InvalidAttributeName

MaximumDepthExceeded

GeneratorInErrorState

GenerationComplete

InvalidNumber

NoBuffer

UnknownError Integer

Instances

Eq GeneratorError

Show GeneratorError

Typeable GeneratorError

Exception GeneratorError

newGenerator :: GeneratorConfig -> ST s (Generator s)

Create a new, empty generator with the given configuration.

getBuffer :: Generator s -> ST s ByteString

Retrieve the NUL-terminated byte buffer.

clearBuffer :: Generator s -> ST s ()

Clear the generator's output buffer. This does not change the state of the generator.

Generator events

generateNull :: Generator s -> ST s ()

generateBoolean :: Generator s -> Bool -> ST s ()

generateIntegral :: Integral a => Generator s -> a -> ST s ()

generateDouble :: Generator s -> Double -> ST s ()

generateNumber :: Generator s -> ByteString -> ST s ()

generateText :: Generator s -> Text -> ST s ()

generateBeginArray :: Generator s -> ST s ()

generateEndArray :: Generator s -> ST s ()

generateBeginObject :: Generator s -> ST s ()

generateEndObject :: Generator s -> ST s ()