summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorSam Scott <sam.scott89@gmail.com>2017-03-10 13:27:42 -0500
committerSam Scott <sam.scott89@gmail.com>2017-03-10 13:27:42 -0500
commit31b5e882aa9058bf19534ab40ee6efa1ce6b2d73 (patch)
treea3d0b73556985f3e73e7a9c0004c0567ef31645c /src/lib.rs
parent6aecad1c9a907c0dc567aef3388bb1857f9ed47d (diff)
Cleaning up, modifying docs.
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs18
1 files changed, 15 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index a1ce6c3..f28d916 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,8 +1,20 @@
//! Serde support for querystring-style strings
+//!
+//! Querystrings are not formally defined and loosely take the form of
+//! _nested_ urlencoded queries.
+//!
+//! This library aims for compatability with the syntax of
+//! [qs](https://github.com/ljharb/qs) and also of the [Rack::Utils::parse_neste
+//! d_query](http://www.rubydoc.info/github/rack/rack/Rack/Utils
+//! #parse_nested_query-class_method) implementation.
+//!
+//! For users who do *not* require nested URL parameters, it is highly
+//! recommended that the `serde_urlencoded` crate is used instead, which
+//! will almost certainly perform better for deserializing simple inputs.
+//!
+//! The serialization implementation of this library is adapted from
+//! `serde_urlencoded`.
-#![warn(unused_extern_crates)]
-
-extern crate fnv;
extern crate itoa;
extern crate dtoa;
#[macro_use]