Merge pull request diesel-rs#925 from KeenS/mac_addr

implement macaddr

Author: Eijebong

CHANGELOG.md

@@ -8,9 +8,12 @@ for Rust libraries in [RFC #1105](https://github.com/rust-lang/rfcs/blob/master/
 
 ### Added
 
+* Added support for the [PostgreSQL network types][pg-network-0.13.1] `MACADDR`.
+
 * Added a function which maps to SQL `NOT`. See [the docs][not-0.14.0] for more
   details.
 
+[pg-network-0.13.1]: https://www.postgresql.org/docs/9.6/static/datatype-net-types.html
 [not-0.14.0]: http://docs.diesel.rs/diesel/expression/dsl/fn.not.html
 
 ## [0.13.0] - 2017-05-15

diesel/src/pg/types/mod.rs

@@ -280,6 +280,72 @@ pub mod sql_types {
     /// ```
     #[derive(Debug, Clone, Copy, Default)] pub struct Money;
 
+    #[cfg(feature = "network-address")]
+    /// The [`MACADDR`](https://www.postgresql.org/docs/9.6/static/datatype-net-types.html) SQL type. This type can only be used with `feature = "network-address"`
+    ///
+    /// ### [`ToSql`](/diesel/types/trait.ToSql.html) impls
+    ///
+    /// - `[u8; 6]`
+    ///
+    /// ### [`FromSql`](/diesel/types/trait.FromSql.html) impls
+    ///
+    /// - `[u8; 6]`
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # #![allow(dead_code)]
+    /// # #[macro_use] extern crate diesel_codegen;
+    /// # #[macro_use] extern crate diesel;
+    /// # include!("src/doctest_setup.rs");
+    /// #
+    /// # table! {
+    /// #     users {
+    /// #         id -> Serial,
+    /// #         name -> VarChar,
+    /// #     }
+    /// # }
+    /// #
+    /// # use diesel::types::MacAddr;
+    ///
+    /// #[derive(Queryable)]
+    /// struct Device {
+    ///     id: i32,
+    ///     macaddr: [u8; 6],
+    /// }
+    ///
+    /// #[derive(Insertable)]
+    /// #[table_name="devices"]
+    /// struct NewDevice {
+    ///     macaddr: [u8;6],
+    /// }
+    ///
+    /// table! {
+    ///     devices {
+    ///         id -> Integer,
+    ///         macaddr -> MacAddr,
+    ///     }
+    /// }
+    ///
+    /// # fn main() {
+    /// #     use self::diesel::insert;
+    /// #     use self::devices::dsl::*;
+    /// #     let connection = connection_no_data();
+    /// #     connection.execute("CREATE TABLE devices (
+    /// #         id SERIAL PRIMARY KEY,
+    /// #         macaddr MACADDR NOT NULL
+    /// #     )").unwrap();
+    /// let new_device = NewDevice {
+    ///     macaddr: [0x08, 0x00, 0x2b, 0x01, 0x02, 0x03],
+    /// };
+    /// let inserted_device = insert(&new_device).into(devices)
+    ///     .get_result::<Device>(&connection).unwrap();
+    /// assert_eq!([0x08, 0x00, 0x2b, 0x01, 0x02, 0x03], inserted_device.macaddr);
+    /// # }
+    /// ```
+    #[derive(Debug, Clone, Copy, Default)]
+    pub struct MacAddr;
+
     /// The [`CIDR`](https://www.postgresql.org/docs/9.6/static/datatype-net-types.html) SQL type. This type can only be used with `feature = "network-address"`
     ///
     /// ### [`ToSql`](/diesel/types/trait.ToSql.html) impls

diesel/src/pg/types/network_address.rs

@@ -21,6 +21,8 @@ const AF_INET: u8 = libc::AF_INET as u8;
 const PGSQL_AF_INET: u8 = AF_INET;
 const PGSQL_AF_INET6: u8 = AF_INET + 1;
 
+// https://github.com/postgres/postgres/blob/502a3832cc54c7115dacb8a2dae06f0620995ac6/src/include/catalog/pg_type.h#L435-L443
+primitive_impls!(MacAddr -> ([u8; 6], pg: (829, 1040)));
 primitive_impls!(Cidr -> (IpNetwork, pg: (650, 651)));
 primitive_impls!(Inet -> (IpNetwork, pg: (869, 1041)));
 
@@ -39,6 +41,23 @@ macro_rules! assert_or_error {
     };
 }
 
+impl FromSql<types::MacAddr, Pg> for [u8; 6] {
+    fn from_sql(bytes: Option<&[u8]>) -> Result<Self, Box<Error + Send + Sync>> {
+        let bytes = not_none!(bytes);
+        assert_or_error!(6 == bytes.len(), "input isn't 6 bytes.");
+        Ok([bytes[0], bytes[1], bytes[2], bytes[3], bytes[4], bytes[5]])
+    }
+
+}
+
+impl ToSql<types::MacAddr, Pg> for [u8; 6] {
+    fn to_sql<W: Write>(&self, out: &mut W) -> Result<IsNull, Box<Error + Send + Sync>> {
+        out.write_all(&self[..])
+            .map(|_| IsNull::No)
+            .map_err(|e| Box::new(e) as Box<Error + Send + Sync>)
+
+   }
+}
 macro_rules! impl_Sql {
     ($ty: ty, $net_type: expr) => {
         impl FromSql<$ty, Pg> for IpNetwork {
@@ -115,6 +134,15 @@ impl_Sql!(types::Inet, 0);
 impl_Sql!(types::Cidr, 1);
 
 
+#[test]
+fn macaddr_roundtrip() {
+    let mut bytes = vec![];
+    let input_address = [0x52, 0x54,0x00, 0xfb, 0xc6, 0x16];
+    ToSql::<types::MacAddr, Pg>::to_sql(&input_address, &mut bytes).unwrap();
+    let output_address:[u8; 6] = FromSql::from_sql(Some(bytes.as_ref())).unwrap();
+    assert_eq!(input_address, output_address);
+}
+
 #[test]
 fn v4address_to_sql() {
     macro_rules! test_to_sql {

diesel_tests/tests/types.rs

@@ -453,6 +453,24 @@ fn pg_uuid_to_sql_uuid() {
     assert!(!query_to_sql_equality::<Uuid, uuid::Uuid>(expected_non_equal_value, value));
 }
 
+#[test]
+#[cfg(feature = "postgres")]
+fn pg_macaddress_from_sql() {
+    let query = "'08:00:2b:01:02:03'::macaddr";
+    let expected_value = [0x08, 0x00, 0x2b, 0x01, 0x02, 0x03];
+    assert_eq!(expected_value,
+               query_single_value::<MacAddr, [u8; 6]>(query));
+}
+
+#[test]
+#[cfg(feature = "postgres")]
+fn pg_macaddress_to_sql_macaddress() {
+    let expected_value = "'08:00:2b:01:02:03'::macaddr";
+    let value = [0x08, 0x00, 0x2b, 0x01, 0x02, 0x03];
+    assert!(query_to_sql_equality::<MacAddr, [u8; 6]>(expected_value, value));
+}
+
+
 #[test]
 #[cfg(feature = "postgres")]
 fn pg_v4address_from_sql() {

diesel_tests/tests/types_roundtrip.rs

@@ -107,12 +107,18 @@ mod pg_types {
     test_round_trip!(array_of_bigint_roundtrips, Array<BigInt>, Vec<i64>);
     test_round_trip!(array_of_dynamic_size_roundtrips, Array<Text>, Vec<String>);
     test_round_trip!(array_of_nullable_roundtrips, Array<Nullable<Text>>, Vec<Option<String>>);
+    test_round_trip!(macaddr_roundtrips, MacAddr, (u8, u8, u8, u8, u8, u8), mk_macaddr);
 
     fn mk_uuid(data: (u32, u16, u16, (u8, u8, u8, u8, u8, u8, u8, u8))) -> self::uuid::Uuid {
         let a = data.3;
         let b = [a.0, a.1, a.2, a.3, a.4, a.5, a.6, a.7];
         uuid::Uuid::from_fields(data.0, data.1, data.2, &b).unwrap()
     }
+
+    fn mk_macaddr(data: (u8, u8, u8, u8, u8, u8)) -> [u8; 6] {
+        [data.0, data.1, data.2, data.3, data.4, data.5]
+    }
+
 }
 
 #[cfg(feature = "mysql")]