Rename “hdf5-rs” crate to “hdf5”

Author: aldanor

CHANGELOG.md

@@ -85,7 +85,7 @@
   `hdf5-sys` (contains bindings, requires `libhdf5-lib` at build time in order to conditionally
   enable or disable certain HDF5 functionality), and `hdf5-rs` (the user-facing crate, requires
   both lower-level crates at build time).
-- Added `h5::hdf5_version` function.
+- Added `hdf5::hdf5_version` function.
 - The minimum required version of the HDF5 library is now 1.8.4.
 - Both `hdf5-sys` and `hdf5-rs` crates can now use version attributes at compile time to
   enable/disable/change functionality. All functions and definitions that appeared in HDF5 versions

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "hdf5-rs"
+name = "hdf5"
 version = "0.2.0"
 authors = ["Ivan Smirnov <[email protected]>"]
 keywords = ["hdf5"]
@@ -11,9 +11,6 @@ homepage = "https://github.com/aldanor/hdf5-rs"
 build = "build.rs"
 edition = "2018"
 
-[lib]
-name = "h5"
-
 [features]
 default = []
 mpio = ["mpi-sys", "hdf5-sys/mpio"]

README.md

@@ -12,28 +12,28 @@ Requires HDF5 library of version 1.8.4 or later.
 ## Example
 
 ```rust
-#[derive(h5::H5Type, Clone, PartialEq, Debug)]
+#[derive(hdf5::H5Type, Clone, PartialEq, Debug)]
 #[repr(u8)]
 pub enum Color {
     RED = 1,
     GREEN = 2,
     BLUE = 3,
 }
 
-#[derive(h5::H5Type, Clone, PartialEq, Debug)]
+#[derive(hdf5::H5Type, Clone, PartialEq, Debug)]
 #[repr(C)]
 pub struct Pixel {
     xy: (i64, i64),
     color: Color,
 }
 
-fn main() -> h5::Result<()> {
+fn main() -> hdf5::Result<()> {
     use self::Color::*;
     use ndarray::{arr1, arr2};
 
     {
         // write
-        let file = h5::File::open("pixels.h5", "w")?;
+        let file = hdf5::File::open("pixels.h5", "w")?;
         let colors = file.new_dataset::<Color>().create("colors", 2)?;
         colors.write(&[RED, BLUE])?;
         let group = file.create_group("dir")?;
@@ -45,7 +45,7 @@ fn main() -> h5::Result<()> {
     }
     {
         // read
-        let file = h5::File::open("pixels.h5", "r")?;
+        let file = hdf5::File::open("pixels.h5", "r")?;
         let colors = file.dataset("colors")?;
         assert_eq!(colors.read_1d::<Color>()?, arr1(&[RED, BLUE]));
         let pixels = file.dataset("dir/pixels")?;

tests/common/gen.rs

@@ -1,8 +1,8 @@
 use std::fmt;
 use std::iter;
 
-use h5::types::{FixedAscii, FixedUnicode, VarLenArray, VarLenAscii, VarLenUnicode};
-use h5::H5Type;
+use hdf5::types::{FixedAscii, FixedUnicode, VarLenArray, VarLenAscii, VarLenUnicode};
+use hdf5::H5Type;
 use hdf5_types::Array;
 
 use ndarray::{ArrayD, SliceInfo, SliceOrIndex};

tests/common/util.rs

@@ -4,7 +4,7 @@ pub fn random_filename() -> String {
     gen_ascii(&mut rand::thread_rng(), 8)
 }
 
-pub fn new_in_memory_file() -> h5::Result<h5::File> {
+pub fn new_in_memory_file() -> hdf5::Result<hdf5::File> {
     let filename = random_filename();
-    h5::File::with_options().mode("w").driver("core").filebacked(false).open(&filename)
+    hdf5::File::with_options().mode("w").driver("core").filebacked(false).open(&filename)
 }

tests/test_dataset.rs

@@ -11,10 +11,10 @@ use self::common::gen::{gen_arr, gen_slice, Enum, FixedStruct, Gen, TupleStruct,
 use self::common::util::new_in_memory_file;
 
 fn test_write_slice<T, R>(
-    rng: &mut R, ds: &h5::Dataset, arr: &ArrayD<T>, default_value: &T, _ndim: usize,
-) -> h5::Result<()>
+    rng: &mut R, ds: &hdf5::Dataset, arr: &ArrayD<T>, default_value: &T, _ndim: usize,
+) -> hdf5::Result<()>
 where
-    T: h5::H5Type + fmt::Debug + PartialEq + Gen + Clone,
+    T: hdf5::H5Type + fmt::Debug + PartialEq + Gen + Clone,
     R: Rng + ?Sized,
 {
     let shape = arr.shape();
@@ -40,10 +40,10 @@ where
 }
 
 fn test_read_slice<T, R>(
-    rng: &mut R, ds: &h5::Dataset, arr: &ArrayD<T>, ndim: usize,
-) -> h5::Result<()>
+    rng: &mut R, ds: &hdf5::Dataset, arr: &ArrayD<T>, ndim: usize,
+) -> hdf5::Result<()>
 where
-    T: h5::H5Type + fmt::Debug + PartialEq + Gen,
+    T: hdf5::H5Type + fmt::Debug + PartialEq + Gen,
     R: Rng + ?Sized,
 {
     ds.write(arr)?;
@@ -78,7 +78,7 @@ where
     let bad_slice = gen_slice(rng, &bad_shape);
     let bad_slice: SliceInfo<_, IxDyn> = ndarray::SliceInfo::new(bad_slice.as_slice()).unwrap();
 
-    let bad_sliced_read: h5::Result<ArrayD<T>> = dsr.read_slice(&bad_slice);
+    let bad_sliced_read: hdf5::Result<ArrayD<T>> = dsr.read_slice(&bad_slice);
     assert!(bad_sliced_read.is_err());
 
     // Tests for dimension-dropping slices with static dimensionality.
@@ -102,9 +102,9 @@ where
     Ok(())
 }
 
-fn test_read<T>(ds: &h5::Dataset, arr: &ArrayD<T>, ndim: usize) -> h5::Result<()>
+fn test_read<T>(ds: &hdf5::Dataset, arr: &ArrayD<T>, ndim: usize) -> hdf5::Result<()>
 where
-    T: h5::H5Type + fmt::Debug + PartialEq + Gen,
+    T: hdf5::H5Type + fmt::Debug + PartialEq + Gen,
 {
     ds.write(arr)?;
 
@@ -143,9 +143,9 @@ where
     Ok(())
 }
 
-fn test_write<T>(ds: &h5::Dataset, arr: &ArrayD<T>, ndim: usize) -> h5::Result<()>
+fn test_write<T>(ds: &hdf5::Dataset, arr: &ArrayD<T>, ndim: usize) -> hdf5::Result<()>
 where
-    T: h5::H5Type + fmt::Debug + PartialEq + Gen,
+    T: hdf5::H5Type + fmt::Debug + PartialEq + Gen,
 {
     // .write()
     ds.write(arr)?;
@@ -166,9 +166,9 @@ where
     Ok(())
 }
 
-fn test_read_write<T>() -> h5::Result<()>
+fn test_read_write<T>() -> hdf5::Result<()>
 where
-    T: h5::H5Type + fmt::Debug + PartialEq + Gen + Clone,
+    T: hdf5::H5Type + fmt::Debug + PartialEq + Gen + Clone,
 {
     let td = T::type_descriptor();
     let mut packed = vec![false];
@@ -185,7 +185,7 @@ where
                 for mode in 0..4 {
                     let arr: ArrayD<T> = gen_arr(&mut rng, ndim);
 
-                    let ds: h5::Dataset = file
+                    let ds: hdf5::Dataset = file
                         .new_dataset::<T>()
                         .packed(*packed)
                         .create("x", arr.shape().to_vec())?;
@@ -213,7 +213,7 @@ where
 }
 
 #[test]
-fn test_read_write_primitive() -> h5::Result<()> {
+fn test_read_write_primitive() -> hdf5::Result<()> {
     test_read_write::<i8>()?;
     test_read_write::<i16>()?;
     test_read_write::<i32>()?;
@@ -231,27 +231,27 @@ fn test_read_write_primitive() -> h5::Result<()> {
 }
 
 #[test]
-fn test_read_write_enum() -> h5::Result<()> {
+fn test_read_write_enum() -> hdf5::Result<()> {
     test_read_write::<Enum>()
 }
 
 #[test]
-fn test_read_write_tuple_struct() -> h5::Result<()> {
+fn test_read_write_tuple_struct() -> hdf5::Result<()> {
     test_read_write::<TupleStruct>()
 }
 
 #[test]
-fn test_read_write_fixed_struct() -> h5::Result<()> {
+fn test_read_write_fixed_struct() -> hdf5::Result<()> {
     test_read_write::<FixedStruct>()
 }
 
 #[test]
-fn test_read_write_varlen_struct() -> h5::Result<()> {
+fn test_read_write_varlen_struct() -> hdf5::Result<()> {
     test_read_write::<VarLenStruct>()
 }
 
 #[test]
-fn test_read_write_tuples() -> h5::Result<()> {
+fn test_read_write_tuples() -> hdf5::Result<()> {
     test_read_write::<(u8,)>()?;
     test_read_write::<(u64, f32)>()?;
     test_read_write::<(i8, u64, f32)>()?;