xml-conduit

Pure-Haskell utilities for dealing with XML with the conduit package.

http://github.com/snoyberg/xml

Version on this page:1.9.1.1@rev:1
LTS Haskell 20.15:1.9.1.1@rev:2
Stackage Nightly 2023-03-24:1.9.1.2
Latest on Hackage:1.9.1.2

See all snapshots xml-conduit appears in

MIT licensed by Michael Snoyman, Aristid Breitkreuz
Maintained by Michael Snoyman
This version can be pinned in stack with:xml-conduit-1.9.1.1@sha256:fb43f1fb0811af3d3116420d18480b19ed40b72f1b43e1baedd7515312d09174,3103

Module documentation for 1.9.1.1

xml-conduit

This package provides parsing and rendering functions for XML. It is based on the datatypes found in the xml-types package. This package is broken up into the following modules:

  • Text.XML: DOM-based parsing and rendering. This is the most commonly used module.

  • Text.XML.Cursor: A wrapper around Text.XML which allows bidirectional traversing of the DOM, similar to XPath. (Note: Text.XML.Cursor.Generic is the same concept, but will work with any node representation.)

  • Text.XML.Unresolved: A slight modification to Text.XML which does not require all entities to be resolved at parsing. The datatypes are slightly more complicated here, and therefore this module is only recommended when you need to deal directly with raw entities.

  • Text.XML.Stream.Parse: Streaming parser, including some streaming parser combinators.

  • Text.XML.Stream.Render: Streaming renderer.

Additionally, the xml-hamlet package provides a more convenient syntax for creating XML documents. For a more thorough tutorial on this library, please see http://www.yesodweb.com/book/xml.

Changes

1.9.1.1

  • Entity declarations with tags inside are now correctly handled
  • Parser now fails gracefully on malformed entity declarations
  • Parameter entity declarations are now ignored

1.9.1

  • ] characters inside doctype are now correctly handled
  • Entity expansion loops are now detected and avoided
  • Add field psEntityExpansionSizeLimit in ParseSettings to limit the length of an entity expansion; set to 8192 characters by default

1.9.0

  • Remove deprecated functions (ignoreTag, ignoreAllTreesContent, takeAllTreesContent)
  • Rename parseText' into parseText
  • takeContent and ignoreContent now cover entities
  • Align behaviour of take* and ignore* functions

1.8.0.1

  • Use doctest to validate code examples from documentation

1.8.0

  • Upgrade to conduit 1.3.0

1.7.1

  • Add psDecodeIllegalCharacters field in ParseSettings to specify how illegal characters references should be decoded
  • Fix compatibility with GHC 8.4.1 #121

1.7.0

  • psDecodeEntities is no longer passed numeric character references (e.g.,  , A) and the predefined XML entities (&, <, etc). They are now handled by the parser. Both of these construct classes only have one spec-compliant interpretation and this behaviour must always be present, so it makes no sense to force user code to re-implement the parsing logic.
  • In prior versions of xml-conduit, hexadecimal character references with a leading 0x or 0X like &0x20; were accepted. This was not in compliance with the XML specification and it has been corrected.
  • xml-conduit now rejects some (but not all) invalid-according-to-spec entities during parsing: specifically, entities with a leading # that are not character references are no longer allowed and will be parse errors.

1.6.0

  • Dropped the dependency on data-default for data-default-class, reducing the transitive dependency load. For most users, this will not be a breaking change, but it does mean that importing Text.XML.Conduit will no longer bring various instances for Default into scope. This will break code that relies on those instances and does not otherwise see them. To fix this, import Data.Default from data-default or one of the more specific instance-providing packages directly (e.g., data-default-dlist for the DList instance).

1.5.1

  • New render setting, rsXMLDeclaration; setting it to False omits the XML declaration.

1.5.0

  • tag function no longer throws an exception when attributes don’t match #93
  • Add many_ combinator to avoid building results in memory #94
  • Turn some functions from Consumer Event m a to ConduitM Event o m a to allow yielding values
  • Replace takeAllTreesContent with takeAnyTreeContent, that only consumes one tree
  • Introduce NameMatcher type to refactor tag parsers
  • Add a couple of take* functions to stream events rather than parse them
  • Rename ignore* functions to comply with naming convention

1.4.0.3

  • Compatibility with blaze-markup-0.8.0.0 #95

1.4.0.2

  • Parse XML encoding case-insensitively
  • Remove extra EOL when printing XmlException

1.4.0.1

  • Handle CDATA in takeAllTreesContent #88

1.4.0

  • Improve XmlException definition and usage
  • Add ‘takeAllTreesContent’ function

1.3.5

  • Improvements for using xml-conduit for streaming XML protocols #85

1.3.4.2

  • transformers dep bump

1.3.4.1

  • Remove unneeded ImpredicativeTypes

1.3.4

  • dropWS retains consumed whitespace values #74 #75 #76

1.3.3.1

  • Generalize signature of choose (Fixes #72) #73

1.3.3

  • New render setting to control when to use CDATA #68
  • Escaping CDATA closing tag in CDATA #69

1.3.2

  • Support for iso-8859-1 #63

1.3.1

  • Add functions to ignore subtrees & result-streaming (yield) parsers #58

1.3.0

  • Drop system-filepath

1.2.6

  • Reuse ‘MonadThrow’ and ‘force’ for ‘AttrParser’ #52

1.2.5

  • Added helper functions to render XML elements #48

1.2.4

  • ‘parseText’ becomes ‘parseText’/‘parseTextPos’, depending on the output type #47

1.2.3.3

  • Allow blaze-builder 0.4

1.2.3.2

1.2.3.1

Support monad-control 1.0

A service provided by FP Complete