Document type support on ToSql and FromSql

This also lets us turn back on all of the features in doc builds

Author: sfackler

.travis.yml

@@ -10,9 +10,9 @@ before_script:
 script:
 - cargo test
 - cargo test --features "uuid rustc-serialize time unix_socket serde chrono openssl"
-- cargo doc --no-deps --features "unix_socket openssl"
+- cargo doc --no-deps --features "unix_socket openssl rustc-serialize time unix_socket serde chrono openssl"
 after_success:
-  - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && test $TRAVIS_RUST_VERSION == "nightly" && ./.travis/update_docs.sh
+  - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && test $TRAVIS_RUST_VERSION == "stable" && ./.travis/update_docs.sh
 env:
   global:
     secure: cZEcWfKI7Pml5og9o1zBMYhbj20Pa22kYVDTDEHqvOoe0kq1cnB5sTH7P0FUgiPq2Ax4B8eQIaC30yvFJ02R7kmTys4aQD98NyCyzdO+dqYi93C9PFYGhl/DKsb4iZ2VP+8LffYSwRGsNSzE9Fj9SFRMIOjHN+UfaVHXaUVjE7Y=

src/types/mod.rs

@@ -460,6 +460,48 @@ make_postgres_type! {
 }
 
 /// A trait for types that can be created from a Postgres value.
+///
+/// # Types
+///
+/// The following implementations are provided by this crate, along with the
+/// corresponding Postgres types:
+///
+/// | Rust type                                   | Postgres type(s)               |
+/// |---------------------------------------------|--------------------------------|
+/// | bool                                        | BOOL                           |
+/// | i8                                          | "char"                         |
+/// | i16                                         | SMALLINT, SMALLSERIAL          |
+/// | i32                                         | INT, SERIAL                    |
+/// | u32                                         | OID                            |
+/// | i64                                         | BIGINT, BIGSERIAL              |
+/// | f32                                         | REAL                           |
+/// | f64                                         | DOUBLE PRECISION               |
+/// | String                                      | VARCHAR, CHAR(n), TEXT, CITEXT |
+/// | Vec<u8>                               | BYTEA                          |
+/// | HashMap<String, Option<String>> | HSTORE                         |
+///
+/// In addition, some implementations are provided for types in third party
+/// crates. These are disabled by default; to opt into one of these
+/// implementations, activate the cargo feature corresponding to the crate's
+/// name. For example, the `serde` feature enables the implementation for the
+/// `serde::json::Value` type.
+///
+/// | Rust type                   | Postgres type(s)                    |
+/// |-----------------------------|-------------------------------------|
+/// | serialize::json::Json       | JSON, JSONB                         |
+/// | serde::json::Value          | JSON, JSONB                         |
+/// | time::Timespec              | TIMESTAMP, TIMESTAMP WITH TIME ZONE |
+/// | chrono::NaiveDateTime       | TIMESTAMP                           |
+/// | chrono::DateTime<UTC> | TIMESTAMP WITH TIME ZONE            |
+/// | chrono::NaiveDate           | DATE                                |
+/// | chrono::NaiveTime           | TIME                                |
+/// | uuid::Uuid                  | UUID                                |
+///
+/// # Nullability
+///
+/// In addition to the types listed above, `FromSql` is implemented for
+/// `Option<T>` where `T` implements `FromSql`. An `Option<T>` represents a
+/// nullable Postgres value.
 pub trait FromSql: Sized {
     /// Creates a new value of this type from a `Read` of Postgres data.
     ///
@@ -619,6 +661,50 @@ pub enum IsNull {
 }
 
 /// A trait for types that can be converted into Postgres values.
+///
+/// # Types
+///
+/// The following implementations are provided by this crate, along with the
+/// corresponding Postgres types:
+///
+/// | Rust type                                   | Postgres type(s)               |
+/// |---------------------------------------------|--------------------------------|
+/// | bool                                        | BOOL                           |
+/// | i8                                          | "char"                         |
+/// | i16                                         | SMALLINT, SMALLSERIAL          |
+/// | i32                                         | INT, SERIAL                    |
+/// | u32                                         | OID                            |
+/// | i64                                         | BIGINT, BIGSERIAL              |
+/// | f32                                         | REAL                           |
+/// | f64                                         | DOUBLE PRECISION               |
+/// | String                                      | VARCHAR, CHAR(n), TEXT, CITEXT |
+/// | &str                                        | VARCHAR, CHAR(n), TEXT, CITEXT |
+/// | Vec&lt;u8&gt;                               | BYTEA                          |
+/// | &[u8]                                       | BYTEA                          |
+/// | HashMap&lt;String, Option&lt;String&gt;&gt; | HSTORE                         |
+///
+/// In addition, some implementations are provided for types in third party
+/// crates. These are disabled by default; to opt into one of these
+/// implementations, activate the cargo feature corresponding to the crate's
+/// name. For example, the `serde` feature enables the implementation for the
+/// `serde::json::Value` type.
+///
+/// | Rust type                   | Postgres type(s)                    |
+/// |-----------------------------|-------------------------------------|
+/// | serialize::json::Json       | JSON, JSONB                         |
+/// | serde::json::Value          | JSON, JSONB                         |
+/// | time::Timespec              | TIMESTAMP, TIMESTAMP WITH TIME ZONE |
+/// | chrono::NaiveDateTime       | TIMESTAMP                           |
+/// | chrono::DateTime&lt;UTC&gt; | TIMESTAMP WITH TIME ZONE            |
+/// | chrono::NaiveDate           | DATE                                |
+/// | chrono::NaiveTime           | TIME                                |
+/// | uuid::Uuid                  | UUID                                |
+///
+/// # Nullability
+///
+/// In addition to the types listed above, `ToSql` is implemented for
+/// `Option<T>` where `T` implements `ToSql`. An `Option<T>` represents a
+/// nullable Postgres value.
 pub trait ToSql: fmt::Debug {
     /// Converts the value of `self` into the binary format of the specified
     /// Postgres `Type`, writing it to `out`.