Skip to content

Commit

Permalink
Update README with more info on why (not) to use this
Browse files Browse the repository at this point in the history
  • Loading branch information
samscott89 committed Apr 7, 2024
1 parent a371dac commit 6712664
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -13,9 +13,11 @@ querystrings. This crate is designed to extend [`serde_urlencoded`][urlencoded]
when using nested parameters, similar to those used by [qs][qs] for Node, and
commonly used by Ruby on Rails via [Rack][Rack].

The core of the library was inspired by
[`serde_urlencoded`][urlencoded], which should be preferred
over this crate whenever non-nested query parameters are sufficient. It is built
The core of the library was inspired by [`serde_urlencoded`][urlencoded].
In order to support abitrarily nested structs encoded in arbitrary orders, we
perform two passes over the input string. This likely adds a non-trivial amount
of memory and compute. Due to this `serde_urlencoded` should be preferred
over this crate whenever non-nested query parameters are sufficient. The crate is built
upon [Serde], a high performance generic serialization framework and [rust-url],
a URL parser for Rust.

Expand Down

0 comments on commit 6712664

Please sign in to comment.