Lib.rs

› Parser implementations
#xml-parser #xml #xml-document #xpath #html-parser #parser #html

libxml

A Rust wrapper for libxml2 - the XML C parser and toolkit developed for the Gnome project

by Deyan Ginev, Andreas Franzén and 17 contributors

48 releases

0.3.3 Jul 18, 2023
0.3.2 Mar 7, 2023
0.3.1 Mar 26, 2022
0.3.0 May 27, 2021
0.0.3 Feb 24, 2016

#150 in Parser implementations

Download history 4971/week @ 2024-07-22 5948/week @ 2024-07-29 6657/week @ 2024-08-05 7173/week @ 2024-08-12 5462/week @ 2024-08-19 7464/week @ 2024-08-26 4760/week @ 2024-09-02 4903/week @ 2024-09-09 4494/week @ 2024-09-16 7406/week @ 2024-09-23 6512/week @ 2024-09-30 5257/week @ 2024-10-07 5763/week @ 2024-10-14 4557/week @ 2024-10-21 6149/week @ 2024-10-28 6035/week @ 2024-11-04

22,664 downloads per month
Used in 97 crates (17 directly)

MIT license

760KB
17K SLoC

CI API Documentation License crates.io

Rust wrapper for libxml2.

The main goal of this project is to benefit from libxml2's maturity and stability while the native Rust XML crates mature to be near-drop-in replacements.

As of the 0.2.0 release of the crate, there are some modest safety guarantees:

  • Mutability, as well as ownership - we use Rc<RefCell<T>> wrappers to ensure runtime safety of libxml2 operations already in the Rust layer.
  • Memory safety guarantees - in particular Node and Document objects have automatic bookkeeping and deallocation on drop, for leak-free wrapper use.
  • No thread safety - libxml2's global memory management is a challenge to adapt in a thread-safe way with minimal intervention

Coverage: Only covers a subset of libxml2 at the moment, contributions are welcome. We try to increase support with each release.

Welcome! With these caveats, the contributors to the project are migrating production work towards Rust and find a continuing reliance on libxml2 a helpful relief for initial ports. As such, contributions to this crate are welcome, if your workflow is not yet fully supported.

Installation prerequisites

Before performing the usual cargo build/install steps, you need to have the relevant components for using the original libxml2 code. These may become gradually outdated with time - please do let us know by opening a new issue/PR whenever that's the case.

Linux/Debian

On linux systems you'd need the development headers of libxml2 (e.g. libxml2-dev in Debian), as well as pkg-config.

MacOS

Community contributed:

$ brew install libxml2 # e.g. version 2.9.12 
$ ln -s /usr/local/Cellar/libxml2/2.9.12/lib/libxml2.2.dylib /usr/local/lib/libxml-2.0.dylib
$ export LIBXML2=/usr/local/Cellar/libxml2/2.9.12/lib/pkgconfig/libxml-2.0.pc

Windows

Community contributed:

  • manually install builds tools c++ and english language by visiting BuildTools
  • launch cmd prompt with admin privileges and execute these commands sequentially:
C:\> git clone https://github.com/microsoft/vcpkg
C:\> .\vcpkg\bootstrap-vcpkg.bat
C:\> setx /M PATH "%PATH%;c:\vcpkg" && setx VCPKGRS_DYNAMIC "1" /M
C:\> refreshenv
C:\> vcpkg install libxml2:x64-windows
C:\> vcpkg integrate install

Dependencies