hexpat-0.15.1: 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 :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString format' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString formatG :: (NodeClass n c, GenericXMLString tag, GenericXMLString text) => n c tag text -> c ByteString formatNode :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString formatNode' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString formatNodeG :: (NodeClass n c, GenericXMLString tag, GenericXMLString text) => n c tag text -> c ByteString formatTree :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString formatTree' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString xmlHeader :: ByteString treeToSAX :: forall tag text n c. (GenericXMLString tag, GenericXMLString text, Monoid text, NodeClass n 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 formatSAXG :: forall c tag text. (List c, GenericXMLString tag, GenericXMLString text) => c (SAXEvent tag text) -> c ByteString indent :: (NodeClass n c, GenericXMLString tag, GenericXMLString text) => Int -> n c tag text -> n c tag text indent_ :: forall n c tag text. (NodeClass n c, GenericXMLString tag, GenericXMLString text) => Int -> Int -> n c tag text -> n c tag text

High level

format :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

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

format' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

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

formatG :: (NodeClass n c, GenericXMLString tag, GenericXMLString text) => n c tag text -> c ByteString Source

Format document with <?xml.. header - generalized variant that returns a generic list of strict ByteStrings.

formatNode :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

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

formatNode' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

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

formatNodeG :: (NodeClass n c, GenericXMLString tag, GenericXMLString text) => n c tag text -> c ByteString Source

Format XML node with no header - generalized variant that returns a generic list of strict ByteStrings.

Deprecated names

formatTree :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

DEPRECATED: Renamed to format.

formatTree' :: (NodeClass n [], GenericXMLString tag, GenericXMLString text) => n [] tag text -> ByteString Source

DEPRECATED: Renamed to format'.

Low level

xmlHeader :: ByteString Source

The standard XML header with UTF-8 encoding.

treeToSAX :: forall tag text n c. (GenericXMLString tag, GenericXMLString text, Monoid text, NodeClass n 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.

formatSAXG Source

:: forall c tag text . (List c, GenericXMLString tag, GenericXMLString text) => c (SAXEvent tag text) SAX events -> c ByteString Format SAX events with no header - generalized variant that uses generic list.

Indentation

indent Source

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

indent_ Source

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

Produced by Haddock version 2.6.1