Text.XML.Expat.IO

This module wraps the Expat API directly with IO operations everywhere. Basic usage is:

1. Make a new parser: newParser.
2. Set up callbacks on the parser: setStartElementHandler, etc.
3. Feed data into the parser: parse or parseChunk.

Parser Setup

data Parser

newParser :: Maybe Encoding -> IO Parser

Create a Parser. The encoding parameter, if provided, overrides the document's encoding declaration.

Parsing

parse :: Parser -> ByteString -> IO Bool

parse data feeds lazy bytestring data into a parser and returns True if there was no parse error.

data Encoding

Encoding types available for the document encoding.

Constructors

ASCII

UTF8

UTF16

ISO88591

Parser Callbacks

type StartElementHandler = String -> [(String, String)] -> IO ()

The type of the "element started" callback. The first parameter is the element name; the second are the (attribute, value) pairs.

type EndElementHandler = String -> IO ()

The type of the "element ended" callback. The parameter is the element name.

type CharacterDataHandler = String -> IO ()

The type of the "character data" callback. The parameter is the character data processed. This callback may be called more than once while processing a single conceptual block of text.

setStartElementHandler :: Parser -> StartElementHandler -> IO ()

Attach a StartElementHandler to a Parser.

setEndElementHandler :: Parser -> EndElementHandler -> IO ()

Attach an EndElementHandler to a Parser.

setCharacterDataHandler :: Parser -> CharacterDataHandler -> IO ()

Attach an CharacterDataHandler to a Parser.

Lower-level Parsing Interface

parseChunk :: Parser -> ByteString -> Bool -> IO Bool

parseChunk data False feeds strict ByteString data into a Parser. The end of the data is indicated by passing True for the final parameter. parse returns False on a parse error.

Helpers

encodingToString :: Encoding -> String