fix: Gate ObjectReference2 on v1.12.1

There appear to be bugs in the v1.12.0 version which certainly break
ObjectReference2 is an element in compound type. Other bugs were seen
previously as well so this appears to be a more stable option.

Author: JamesMc86

hdf5/src/hl/references/mod.rs

@@ -3,14 +3,14 @@ use crate::Location;
 
 mod legacy;
 
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 mod standard;
 
 use hdf5_sys::h5o::H5O_type_t;
 use hdf5_sys::h5r::H5R_type_t;
 
 pub use legacy::ObjectReference1;
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 pub use standard::ObjectReference2;
 
 pub trait ObjectReference: Sized + H5Type {

hdf5/src/hl/references/standard.rs

@@ -1,5 +1,7 @@
-use std::ops::Deref;
-
+//! New standard reference types introduced in v1.12.0.
+//!
+//! These are gated on v1.12.1 since there appear to be multiple bugs in v1.12.0.
+//!
 use hdf5_sys::h5o::H5O_type_t;
 use hdf5_sys::h5r::H5R_type_t::H5R_OBJECT2;
 use hdf5_sys::h5r::{H5R_ref_t, H5Rcreate_object, H5Rdestroy, H5Rget_obj_type3, H5Ropen_object};
@@ -10,28 +12,37 @@ use crate::Location;
 
 /// A reference to a HDF5 item that can be stored in attributes or datasets.
 #[repr(transparent)]
-pub struct StdReference {
-    inner: H5R_ref_t,
-}
+pub struct StdReference(H5R_ref_t);
 
 impl StdReference {
     fn ptr(&self) -> *const H5R_ref_t {
-        std::ptr::addr_of!(self.inner)
+        std::ptr::addr_of!(self.0)
     }
 }
 
-#[repr(transparent)]
-#[derive(Debug)]
-pub struct ObjectReference2(StdReference);
+//todo: could we query some actual object parameters to make this more useful?
+impl std::fmt::Debug for StdReference {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_str("StdReference")
+    }
+}
 
-impl Deref for ObjectReference2 {
-    type Target = StdReference;
+unsafe impl H5Type for StdReference {
+    fn type_descriptor() -> hdf5_types::TypeDescriptor {
+        hdf5_types::TypeDescriptor::Reference(hdf5_types::Reference::Std)
+    }
+}
 
-    fn deref(&self) -> &Self::Target {
-        &self.0
+impl Drop for StdReference {
+    fn drop(&mut self) {
+        let _e = h5call!(H5Rdestroy(&mut self.0));
     }
 }
 
+#[repr(transparent)]
+#[derive(Debug)]
+pub struct ObjectReference2(StdReference);
+
 impl ObjectReference for ObjectReference2 {
     const REF_TYPE: hdf5_sys::h5r::H5R_type_t = H5R_OBJECT2;
 
@@ -41,7 +52,7 @@ impl ObjectReference for ObjectReference2 {
 
     fn create(location: &Location, name: &str) -> Result<Self> {
         let reference: H5R_ref_t = create_object_reference(location, name)?;
-        Ok(Self(StdReference { inner: reference }))
+        Ok(Self(StdReference(reference)))
     }
 
     fn get_object_type(&self, _location: &Location) -> Result<hdf5_sys::h5o::H5O_type_t> {
@@ -64,25 +75,6 @@ unsafe impl H5Type for ObjectReference2 {
     }
 }
 
-//todo: could we query some actual object parameters to make this more useful?
-impl std::fmt::Debug for StdReference {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        f.write_str("StdReference")
-    }
-}
-
-unsafe impl H5Type for StdReference {
-    fn type_descriptor() -> hdf5_types::TypeDescriptor {
-        hdf5_types::TypeDescriptor::Reference(hdf5_types::Reference::Std)
-    }
-}
-
-impl Drop for StdReference {
-    fn drop(&mut self) {
-        let _e = h5call!(H5Rdestroy(&mut self.inner));
-    }
-}
-
 fn create_object_reference(dataset: &Location, name: &str) -> Result<H5R_ref_t> {
     let mut out: std::mem::MaybeUninit<H5R_ref_t> = std::mem::MaybeUninit::uninit();
     let name = to_cstring(name)?;

hdf5/src/lib.rs

@@ -67,7 +67,7 @@ mod export {
         },
     };
 
-    #[cfg(feature = "1.12.0")]
+    #[cfg(feature = "1.12.1")]
     pub use crate::hl::references::ObjectReference2;
 
     #[doc(hidden)]

hdf5/tests/test_object_references.rs

@@ -4,7 +4,7 @@
 mod common;
 
 use common::util::new_in_memory_file;
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 use hdf5::ObjectReference2;
 use hdf5::{H5Type, ObjectReference, ObjectReference1, ReferencedObject};
 
@@ -217,30 +217,30 @@ fn test_reference_in_datatype_object_reference1() {
     test_reference_in_datatype::<ObjectReference1>();
 }
 
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 #[test]
 fn test_group_references_with_objectreference2() {
     test_group_references::<ObjectReference2>();
 }
 
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 #[test]
 fn test_dataset_references_with_object_reference2() {
     test_dataset_references::<ObjectReference2>();
 }
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 #[test]
 fn test_reference_in_attribute_object_reference2() {
     test_reference_in_attribute::<ObjectReference2>();
 }
 
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 #[test]
 fn test_reference_errors_on_attribute_object_reference2() {
     test_reference_errors_on_attribute::<ObjectReference2>();
 }
 
-#[cfg(feature = "1.12.0")]
+#[cfg(feature = "1.12.1")]
 #[test]
 fn test_reference_in_datatype_object_reference2() {
     test_reference_in_datatype::<ObjectReference2>();