summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorSam Scott <sam.scott89@gmail.com>2017-05-21 11:47:00 +0100
committerSam Scott <sam.scott89@gmail.com>2017-05-21 11:47:00 +0100
commitba5e0b32b71f7f79915d671e64d19bf9f2bcf422 (patch)
tree012ba94bdfc7f4e934301851364beadae47d567b /src/lib.rs
parent661cc9697a1c31abe786e45e43072800b6641871 (diff)
Updates to documentation.
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs13
1 files changed, 10 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 10b30f3..0e2e9d7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -12,8 +12,15 @@
//! 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`.
+//! ## Supported Types
+//!
+//! At the **top level**, `serde_qs` only supports `struct`, `map`, and `enum`.
+//! These are the only top-level structs which can be de/serialized since
+//! Querystrings rely on having a (key, value) pair for each field, which
+//! necessitates this kind of structure.
+//!
+//! However, after the top level you should find all supported types can be
+//! de/serialized.
//!
//! ## Usage
//!
@@ -72,7 +79,7 @@ pub mod de;
pub mod ser;
#[doc(inline)]
-pub use de::{Deserializer, from_bytes, from_reader, from_str};
+pub use de::{QsDeserializer, from_bytes, from_reader, from_str};
#[doc(inline)]
pub use de::Config;
#[doc(inline)]