View Source Saxaboom (Saxaboom v0.2.1)

The main entrypoint for parsing a document from a string or Stream.

Summary

Functions

Parses a given document into a user-defined struct (see: Saxaboom.Mapper for more information)

Functions

Link to this function

parse(xml, into, options \\ [])

View Source

Parses a given document into a user-defined struct (see: Saxaboom.Mapper for more information)

Takes as arguments:

  • xml: a string or stream of XML data
  • into a Saxaboom.Mapper type that describes the document to be parsed

Takes as keyword arguments:

  • adapter: an atom describing the adapter to use when parsing the document
    • Defaults to xmerl
  • parser_options: a list of options to pass down to the chosen adapter. Refer to the parser documentation for more information.

Returns:

  • A tuple containing the status and the parsed structure, optionally error information surfaced from the underlying parser