hexpat-0.13: wrapper for expat, the fast XML parser Source code Contents Index

Text.XML.Expat.Format

Contents High level Deprecated names Low level Indentation

Description

This module provides functions to format a tree structure or SAX stream as UTF-8 encoded XML.

Synopsis

format :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString format' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString formatNode :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString formatNode' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString formatTree :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString formatTree' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString xmlHeader :: ByteString treeToSAX :: (GenericXMLString tag, GenericXMLString text, Monoid text, NodeClass n c, Functor c) => n c tag text -> c (SAXEvent tag text) formatSAX :: (GenericXMLString tag, GenericXMLString text) => [SAXEvent tag text] -> ByteString formatSAX' :: (GenericXMLString tag, GenericXMLString text) => [SAXEvent tag text] -> ByteString indent :: (GenericXMLString tag, GenericXMLString text) => Int -> Node tag text -> Node tag text indent_ :: (GenericXMLString tag, GenericXMLString text) => Int -> Int -> Node tag text -> Node tag text

High level

format :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

Format document with <?xml.. header - lazy variant that returns lazy ByteString.

format' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

Format document with <?xml.. header - strict variant that returns strict ByteString.

formatNode :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

Format XML node with no header - lazy variant that returns lazy ByteString.

formatNode' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

Format XML node with no header - strict variant that returns strict ByteString.

Deprecated names

formatTree :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

DEPRECATED: Renamed to format.

formatTree' :: (GenericXMLString tag, GenericXMLString text) => Node tag text -> ByteString Source

DEPRECATED: Renamed to format'.

Low level

xmlHeader :: ByteString Source

treeToSAX :: (GenericXMLString tag, GenericXMLString text, Monoid text, NodeClass n c, Functor c) => n c tag text -> c (SAXEvent tag text) Source

Flatten a tree structure into SAX events, monadic version.

formatSAX :: (GenericXMLString tag, GenericXMLString text) => [SAXEvent tag text] -> ByteString Source

Format SAX events with no header - lazy variant that returns lazy ByteString.

formatSAX' :: (GenericXMLString tag, GenericXMLString text) => [SAXEvent tag text] -> ByteString Source

Format SAX events with no header - strict variant that returns strict ByteString.

Indentation

indent Source

:: (GenericXMLString tag, GenericXMLString text) => Int Number of indentation spaces per nesting level -> Node tag text -> Node tag text Make the output prettier by adding indentation.

indent_ Source

:: (GenericXMLString tag, GenericXMLString text) => Int Initial indent (spaces) -> Int Number of indentation spaces per nesting level -> Node tag text -> Node tag text Make the output prettier by adding indentation, specifying initial indent.

Produced by Haddock version 2.6.1