RustyXML.SimpleForm (RustyXML v0.2.3)

Parse XML into a simple tree of nested tuples.

Drop-in replacement for Saxy.SimpleForm.

The simple form represents XML as:

{tag_name, attributes, children}

Where:

Examples

RustyXML.SimpleForm.parse_string("<root><item id=\"1\">text</item></root>")
#=> {:ok, {"root", [], [{"item", [{"id", "1"}], ["text"]}]}}

element()

Parse a stream of XML chunks into simple form.

Parse an XML string into simple form.

@type element() :: {String.t(), [{String.t(), String.t()}], [element() | String.t()]}

@spec parse_stream(
  Enumerable.t(),
  keyword()
) :: {:ok, element()} | {:error, any()}

Parse a stream of XML chunks into simple form.

Accumulates all chunks in Rust, then validates, indexes, and builds the SimpleForm tree in one pass. Minimal BEAM memory during accumulation.

File.stream!("large.xml", [], 64 * 1024)
|> RustyXML.SimpleForm.parse_stream()
#=> {:ok, {"root", [], [...]}}

@spec parse_string(
  String.t(),
  keyword()
) :: {:ok, element()} | {:error, any()}

Parse an XML string into simple form.

Returns {:ok, root_element} on success, {:error, exception} on failure.