From 31b5e882aa9058bf19534ab40ee6efa1ce6b2d73 Mon Sep 17 00:00:00 2001 From: Sam Scott Date: Fri, 10 Mar 2017 13:27:42 -0500 Subject: Cleaning up, modifying docs. --- src/lib.rs | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'src/lib.rs') 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] -- cgit v1.2.3