instant-labs
/
instant-xml
mirror of https://github.com/instant-labs/instant-xml.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
202 Commits 4 Branches 4 Tags 960 KiB
Rust 100%
Go to file
Wez Furlong 2156e100ee fix in "URL is not a hyperlinke" in cargo doc 
```
warning: this URL is not a hyperlink
   --> /home/wez/wez-personal/instant-xml/instant-xml/src/de.rs:499:32
    |
499 | /// Valid character ranges per https://www.w3.org/TR/xml/#NT-Char
    |                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.w3.org/TR/xml/#NT-Char>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default
```
 		2024-05-23 00:01:20 +02:00
.github Bump MSRV to 1.61 (for memchr) 2023-10-25 22:36:20 +02:00
instant-xml fix in "URL is not a hyperlinke" in cargo doc 2024-05-23 00:01:20 +02:00
instant-xml-macros emit ::std::result::Result rather than unqualified Result 2024-05-23 00:01:20 +02:00
.gitignore Ignore macOS cruft 2023-09-15 13:04:46 +02:00
Cargo.toml Explicitly set workspace resolver 2023-09-15 13:04:46 +02:00
README.md Add cover image (#51) 2024-02-28 11:13:54 -08:00
cover.svg Add cover image (#51) 2024-02-28 11:13:54 -08:00
deny.toml Ignore unactionable time advisory 2022-11-21 21:33:54 -08:00

README.md

Cover logo

instant-xml: more rigorously mapping XML to Rust types

Documentation Crates.io Build status License: MIT License: Apache 2.0

instant-xml is a serde-like library providing traits and procedural macros to help map XML to Rust types. While serde is great for formats like JSON, the underlying structure it provides is not a great fit for XML, limiting serde-based tools like quick-xml. instant-xml more rigorously maps the XML data model (including namespaces) to Rust types while providing a serde-like interface.

Features

  • Familiar serde-like interface
  • Full support for XML namespaces
  • Avoids copying deserialized data where possible
  • Minimum supported Rust version is 1.58

Limitations

instant-xml is still early in its lifecycle. While it works well for our use cases, it might not work well for you, and several more semver-incompatible releases should be expected to flesh out the core trait APIs as we throw more test cases at it. There's also currently not that much documentation.

We'd love to hear your feedback!

Thanks

Thanks to @rsdy and @choinskib for their work on this library, and thanks (of course) to @dtolnay for creating serde.