QuickXml

QuickXml is an XML parsing library for Elixir using a Rust NIF powered by the quick-xml crate. It provides a fast and efficient way to convert XML strings into Elixir maps.

Installation

Add quick_xml to your list of dependencies in mix.exs:

def deps do
  [
    {:quick_xml, "~> 0.1"}
  ]
end

Force Compilation

This library includes pre-compiled binaries for the native Rust code. If you want to force-compile the Rust code, you can add the following configuration to your application:

config :rustler_precompiled, :force_build, quick_xml: true

You also need to add Rustler to your dependencies:

def deps do
  [
    {:quick_xml, "~> 0.1.0"},
    {:rustler, ">= 0.0.0", optional: true}
  ]
end

Usage

To parse an XML string into an Elixir map, use QuickXml.parse/1:

xml = "<root><name>John</name><age>30</age></root>"
{:ok, parsed_map} = QuickXml.parse(xml)

# Expected output:
{:ok, %{"age" => %{"$text" => "30"}, "name" => %{"$text" => "John"}}}

If the XML is invalid, it returns an error tuple:

{:error, {:invalid_xml, "syntax error: xml must have a node"}}

Benchmarking

It includes a benchmarking script (benchmark.exs) that generates mock XML content to measure parsing performance. You can run it with:

elixir benchmark.exs

For custom XML content size in kilobytes, you can pass the --kb flag with the desired size. For example: elixir benchmark.exs --kb 100.

Sample Benchmark Results

License

QuickXml is released under the MIT License.