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.
Modulexml-conduit-1.10.1.0Haskell2010
Text.XML.Stream.Render.Internal
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.
Synopsis
- value renderBuilder
- value renderBuilderFlush
- value renderBytes
- value renderText
- data RenderSettings
- method def
- value rsPretty
- value rsNamespaces
- value rsAttrOrder
- value rsUseCDATA
- value rsXMLDeclaration
- value orderAttrs
- value document
- value tag
- value content
- data Attributes
- value attr
- value optionalAttr
- Packagexml-conduit-1.10.1.0
- Exports18
- LanguageHaskell2010
- LicenceMIT
- SourceInternal.hs
Rendering XML files
Same as renderBuilder but allows you to flush XML stream to ensure that all events at needed point are rendered.
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.
Render a stream of Events into a stream of Texts. This function wraps around renderBuilder, builderToByteString and renderBytes, so it produces optimally sized Texts with minimal buffer copying.
Renderer settings
Instances1Default
Default RenderSettingsDefined in xml-conduit-1.10.1.0 · Text.XML.Stream.Render.Internal
The default value for this type.
Pretty-print XML document. Implementation is arbitrary and can change the meaning of your XML (e.g. by adding whitespace and newlines in text content.)
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.
Specify how to turn the unordered attributes used by the Text.XML module into an ordered list.
Determines if for a given text content the renderer should use a CDATA node.
Default: False
Determines whether the XML declaration will be output. Note that when using the streaming API the XML declaration will be output only if this is set to true and the stream includes an EventBeginDocument event. Apart from yielding it explicitly, this can be achieved by wrapping the stream in the document function.
Default: True
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.
Event rendering
Wrap the given stream in an EventBeginDocument/EventEndDocument pair.
value
tag Generate a complete XML Element.
Generate a textual EventContent.
Attribute rendering
A list of attributes.
Instances2Semigroup, Monoid
Semigroup AttributesDefined in xml-conduit-1.10.1.0 · Text.XML.Stream.Render.InternalMonoid AttributesDefined in xml-conduit-1.10.1.0 · Text.XML.Stream.Render.Internal
Generate a single attribute.