Update sqlx-core/src/postgres/types/mod.rs

Co-authored-by: Austin Bonander <austin.bonander@gmail.com>
launchbadge · Aug 23, 2022 · 327ac86 · 327ac86
1 parent 5242f85
commit 327ac86
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/sqlx-core/src/postgres/types/mod.rs b/sqlx-core/src/postgres/types/mod.rs
@@ -74,6 +74,12 @@
 //! | `ipnetwork::IpNetwork`                | INET, CIDR                                           |
 //! | `std::net::IpAddr`                    | INET, CIDR                                           |
 //!
+//! Note that because `IpAddr` does not support network prefixes, it is an error to attempt to decode 
+//! an `IpAddr` from a `INET` or `CIDR` value with a network prefix smaller than the address' full width: 
+//! `/32` for IPv4 addresses and `/128` for IPv6 addresses.
+//!
+//! `IpNetwork` does not have this limitation.
+//!
 //! ### [`mac_address`](https://crates.io/crates/mac_address)
 //!
 //! Requires the `mac_address` Cargo feature flag.