Add documentation

Author: daxpedda

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - `no_drop` item-level option to `ZeroizeOnDrop` which does not implement
   `Drop` but instead only asserts that every field implements `ZeroizeOnDrop`.
+- Support deriving Serde's `Deserialize` and `Serialize` trait via Serde's own
+  proc-macro.
 
 ### Changed
 - Error messages now point to crate features instead of reporting traits as

README.md

@@ -200,6 +200,13 @@ assert!(!(StructExample <= StructExample));
 Note that it is not possible to use `incomparable` with [`Eq`] or [`Ord`] as
 that would break their invariants.
 
+### Serde `Deserialize` and `Serialize`
+
+Deriving [`Deserialize`] and [`Serialize`] works as expected. While
+derive-where does not offer any attribute options, regular `serde` attributes
+can be used. Derive-where will respect
+[`#[serde(crate = "...")]`](https://serde.rs/container-attrs.html#crate).
+
 ### `Zeroize` options
 
 `Zeroize` has two options:
@@ -259,11 +266,13 @@ The following traits can be derived with derive-where:
 - [`Copy`]
 - [`Debug`]
 - [`Default`]
+- [`Deserialize`]: Only available with the `serde` crate feature.
 - [`Eq`]
 - [`Hash`]
 - [`Ord`]
 - [`PartialEq`]
 - [`PartialOrd`]
+- [`Serialize`]: Only available with the `serde` crate feature.
 - [`Zeroize`]: Only available with the `zeroize` crate feature.
 - [`ZeroizeOnDrop`]: Only available with the `zeroize` crate feature. If the
   `zeroize-on-drop` feature is enabled, it implements [`ZeroizeOnDrop`],
@@ -352,12 +361,14 @@ conditions.
 [`core::intrinsics::discriminant_value`]: https://doc.rust-lang.org/core/intrinsics/fn.discriminant_value.html
 [`derive_where`]: https://docs.rs/derive-where/latest/derive_where/attr.derive_where.html
 [`Discriminant`]: https://doc.rust-lang.org/core/mem/struct.Discriminant.html
+[`Deserialize`]: https://docs.rs/serde/latest/serde/derive.Deserialize.html
 [`Drop`]: https://doc.rust-lang.org/core/ops/trait.Drop.html
 [`Eq`]: https://doc.rust-lang.org/core/cmp/trait.Eq.html
 [`i32`]: https://doc.rust-lang.org/core/primitive.i32.html
 [`isize`]: https://doc.rust-lang.org/core/primitive.isize.html
 [`Ord`]: https://doc.rust-lang.org/core/cmp/trait.Ord.html
 [`PartialEq`]: https://doc.rust-lang.org/core/cmp/trait.PartialEq.html
 [`PartialOrd`]: https://doc.rust-lang.org/core/cmp/trait.PartialOrd.html
+[`Serialize`]: https://docs.rs/serde/latest/serde/derive.Serialize.html
 [`transmute`]: https://doc.rust-lang.org/core/mem/fn.transmute.html
 [`unreachable`]: https://doc.rust-lang.org/core/macro.unreachable.html

src/lib.rs

@@ -228,6 +228,13 @@
 //! Note that it is not possible to use `incomparable` with [`Eq`] or [`Ord`] as
 //! that would break their invariants.
 //!
+//! ## Serde `Deserialize` and `Serialize`
+//!
+//! Deriving [`Deserialize`] and [`Serialize`] works as expected. While
+//! derive-where does not offer any attribute options, regular `serde`
+//! attributes can be used. Derive-where will respect
+//! [`#[serde(crate = "...")]`](https://serde.rs/container-attrs.html#crate).
+//!
 //! ## `Zeroize` options
 //!
 //! `Zeroize` has two options:
@@ -298,11 +305,13 @@
 //! - [`Copy`]
 //! - [`Debug`]
 //! - [`Default`]
+//! - [`Deserialize`]: Only available with the `serde` crate feature.
 //! - [`Eq`]
 //! - [`Hash`]
 //! - [`Ord`]
 //! - [`PartialEq`]
 //! - [`PartialOrd`]
+//! - [`Serialize`]: Only available with the `serde` crate feature.
 //! - [`Zeroize`]: Only available with the `zeroize` crate feature.
 //! - [`ZeroizeOnDrop`]: Only available with the `zeroize` crate feature. If the
 //!   `zeroize-on-drop` feature is enabled, it implements [`ZeroizeOnDrop`],
@@ -379,11 +388,13 @@
 //! [LICENSE-APACHE]: https://github.com/ModProg/derive-where/blob/main/LICENSE-APACHE
 //! [`Debug`]: core::fmt::Debug
 //! [`Default`]: core::default::Default
+//! [`Deserialize`]: https://docs.rs/serde/latest/serde/derive.Deserialize.html
 //! [`Eq`]: core::cmp::Eq
 //! [`Hash`]: core::hash::Hash
 //! [`Ord`]: core::cmp::Ord
 //! [`PartialEq`]: core::cmp::PartialEq
 //! [`PartialOrd`]: core::cmp::PartialOrd
+//! [`Serialize`]: https://docs.rs/serde/latest/serde/derive.Serialize.html
 //! [`zeroize`]: https://docs.rs/zeroize
 //! [`Zeroize`]: https://docs.rs/zeroize/latest/zeroize/trait.Zeroize.html
 //! [`ZeroizeOnDrop`]: https://docs.rs/zeroize/latest/zeroize/trait.ZeroizeOnDrop.html