| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Text.XML.Stream.Render
Description
Enumeratees to render XML Events. Unlike libxml-enumerator and
expat-enumerator, this module does not provide IO and ST variants, since the
underlying rendering operations are pure functions.
- renderBuilder :: Monad m => RenderSettings -> Conduit Event m Builder
- renderBytes :: (PrimMonad base, MonadBase base m) => RenderSettings -> ConduitM Event ByteString m ()
- renderText :: (PrimMonad base, MonadBase base m, MonadThrow m) => RenderSettings -> ConduitM Event Text m ()
- data RenderSettings
- def :: Default a => a
- rsPretty :: RenderSettings -> Bool
- rsNamespaces :: RenderSettings -> [(Text, Text)]
- rsAttrOrder :: RenderSettings -> Name -> Map Name Text -> [(Name, Text)]
- orderAttrs :: [(Name, [Name])] -> Name -> Map Name Text -> [(Name, Text)]
- prettify :: Monad m => Conduit Event m Event
Documentation
renderBuilder :: Monad m => RenderSettings -> Conduit Event m Builder Source
Render a stream of Events into a stream of Builders. Builders are from
the blaze-builder package, and allow the create of optimally sized
ByteStrings with minimal buffer copying.
renderBytes :: (PrimMonad base, MonadBase base m) => RenderSettings -> ConduitM Event ByteString m () Source
Render a stream of Events into a stream of ByteStrings. This function
wraps around renderBuilder and builderToByteString, so it produces
optimally sized ByteStrings with minimal buffer copying.
The output is UTF8 encoded. renderBytes :: Monad m => RenderSettings -> Conduit Event m ByteString
renderText :: (PrimMonad base, MonadBase base m, MonadThrow m) => RenderSettings -> ConduitM Event Text m () Source
Render a stream of Events into a stream of ByteStrings. This function
wraps around renderBuilder, builderToByteString and renderBytes, so it
produces optimally sized ByteStrings with minimal buffer copying.
data RenderSettings Source
Instances
rsPretty :: RenderSettings -> Bool Source
rsNamespaces :: RenderSettings -> [(Text, Text)] Source
Defines some top level namespace definitions to be used, in the form of (prefix, namespace). This has absolutely no impact on the meaning of your documents, but can increase readability by moving commonly used namespace declarations to the top level.
rsAttrOrder :: RenderSettings -> Name -> Map Name Text -> [(Name, Text)] Source
Specify how to turn the unordered attributes used by the Text.XML module into an ordered list.
orderAttrs :: [(Name, [Name])] -> Name -> Map Name Text -> [(Name, Text)] Source
Convenience function to create an ordering function suitable for
use as the value of rsAttrOrder. The ordering function is created
from an explicit ordering of the attributes, specified as a list of
tuples, as follows: In each tuple, the first component is the
Name of an element, and the second component is a list of
attributes names. When the given element is rendered, the
attributes listed, when present, appear first in the given order,
followed by any other attributes in arbitrary order. If an element
does not appear, all of its attributes are rendered in arbitrary
order.