fix: prefer ipnetwork to ipnet for compatibility

Author: BeauGieskens

sqlx-postgres/src/type_info.rs

@@ -256,7 +256,7 @@ impl PgTypeInfo {
         ]
         .contains(self)
         {
-            Some("ipnet")
+            Some("ipnetwork")
         } else if [PgTypeInfo::MACADDR].contains(self) {
             Some("mac_address")
         } else if [PgTypeInfo::NUMERIC, PgTypeInfo::NUMERIC_ARRAY].contains(self) {

sqlx-postgres/src/types/ipnet/mod.rs

@@ -1,3 +1,5 @@
+// Prefer `ipnetwork` over `ipnet` because it was implemented first (want to avoid breaking change).
+#[cfg(not(feature = "ipnetwork"))]
 mod ipaddr;
 
 // Parent module is named after the `ipnet` crate, this is named after the `IpNet` type.

sqlx-postgres/src/types/ipnetwork/mod.rs

@@ -1,5 +1,3 @@
-// Prefer `ipnet` over `ipnetwork`, as it is more featureful and more widely used.
-#[cfg(not(feature = "ipnet"))]
 mod ipaddr;
 
 // Parent module is named after the `ipnetwork` crate, this is named after the `IpNetwork` type.

sqlx-postgres/src/types/mod.rs

@@ -81,28 +81,28 @@
 //! |---------------------------------------|------------------------------------------------------|
 //! | `uuid::Uuid`                          | UUID                                                 |
 //!
-//! ### [`ipnet`](https://crates.io/crates/ipnet)
+//! ### [`ipnetwork`](https://crates.io/crates/ipnetwork)
 //!
-//! Requires the `ipnet` Cargo feature flag (takes precedence over `ipnetwork` if both are used).
+//! Requires the `ipnetwork` Cargo feature flag (takes precedence over `ipnet` if both are used).
 //!
 //! | Rust type                             | Postgres type(s)                                     |
 //! |---------------------------------------|------------------------------------------------------|
-//! | `ipnet::IpNet`                        | INET, CIDR                                           |
+//! | `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.
 //!
-//! `IpNet` does not have this limitation.
+//! `IpNetwork` does not have this limitation.
 //!
-//! ### [`ipnetwork`](https://crates.io/crates/ipnetwork)
+//! ### [`ipnet`](https://crates.io/crates/ipnet)
 //!
-//! Requires the `ipnetwork` Cargo feature flag.
+//! Requires the `ipnet` Cargo feature flag.
 //!
 //! | Rust type                             | Postgres type(s)                                     |
 //! |---------------------------------------|------------------------------------------------------|
-//! | `ipnetwork::IpNetwork`                | INET, CIDR                                           |
+//! | `ipnet::IpNet`                        | INET, CIDR                                           |
 //! | `std::net::IpAddr`                    | INET, CIDR                                           |
 //!
 //! The same `IpAddr` limitation for smaller network prefixes applies as with `ipnet`.

tests/ui-tests.rs

@@ -18,7 +18,7 @@ fn ui_tests() {
         }
 
         if cfg!(not(feature = "ipnet")) && cfg!(not(feature = "ipnetwork")) {
-            t.compile_fail("tests/ui/postgres/gated/ipnet.rs");
+            t.compile_fail("tests/ui/postgres/gated/ipnetwork.rs");
         }
     }
 

tests/ui/postgres/gated/ipnet.rs renamed to tests/ui/postgres/gated/ipnetwork.rs

@@ -1,29 +1,29 @@
-error: optional sqlx feature `ipnet` required for type INET of column #1 ("inet")
- --> $DIR/ipnet.rs:2:13
+error: optional sqlx feature `ipnetwork` required for type INET of column #1 ("inet")
+ --> $DIR/ipnetwork.rs:2:13
   |
 2 |     let _ = sqlx::query!("select '127.0.0.1'::inet");
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
 
-error: optional sqlx feature `ipnet` required for type CIDR of column #1 ("cidr")
- --> $DIR/ipnet.rs:4:13
+error: optional sqlx feature `ipnetwork` required for type CIDR of column #1 ("cidr")
+ --> $DIR/ipnetwork.rs:4:13
   |
 4 |     let _ = sqlx::query!("select '2001:4f8:3:ba::/64'::cidr");
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
 
-error: optional sqlx feature `ipnet` required for type INET of param #1
- --> $DIR/ipnet.rs:6:13
+error: optional sqlx feature `ipnetwork` required for type INET of param #1
+ --> $DIR/ipnetwork.rs:6:13
   |
 6 |     let _ = sqlx::query!("select $1::inet", ());
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
 
-error: optional sqlx feature `ipnet` required for type CIDR of param #1
- --> $DIR/ipnet.rs:8:13
+error: optional sqlx feature `ipnetwork` required for type CIDR of param #1
+ --> $DIR/ipnetwork.rs:8:13
   |
 8 |     let _ = sqlx::query!("select $1::cidr", ());
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^