Merge pull request #147 from mulimoen/feature/try_into_selection

aldanor · web-flow · commit b762e2268cc6 · 2021-10-13T18:11:28.000+01:00
Use TryFrom over From
diff --git a/hdf5-sys/src/h5.rs b/hdf5-sys/src/h5.rs
@@ -1,3 +1,4 @@
+//! General purpose library functions
 use std::mem;
 
 pub use self::H5_index_t::*;
diff --git a/hdf5-sys/src/h5a.rs b/hdf5-sys/src/h5a.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating HDF5 attributes
 use std::mem;
 
 use crate::internal_prelude::*;
diff --git a/hdf5-sys/src/h5ac.rs b/hdf5-sys/src/h5ac.rs
@@ -1,3 +1,4 @@
+//! Cache functions
 use std::mem;
 
 use crate::internal_prelude::*;
diff --git a/hdf5-sys/src/h5c.rs b/hdf5-sys/src/h5c.rs
@@ -1,3 +1,4 @@
+//! Cache functionality
 pub use self::H5C_cache_decr_mode::*;
 pub use self::H5C_cache_flash_incr_mode::*;
 pub use self::H5C_cache_incr_mode::*;
diff --git a/hdf5-sys/src/h5d.rs b/hdf5-sys/src/h5d.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating scientific datasets
 pub use self::H5D_alloc_time_t::*;
 pub use self::H5D_fill_time_t::*;
 pub use self::H5D_fill_value_t::*;
diff --git a/hdf5-sys/src/h5e.rs b/hdf5-sys/src/h5e.rs
@@ -1,3 +1,4 @@
+//! Functions for handling errors that occur within HDF5
 use std::mem;
 
 pub use self::H5E_direction_t::*;
diff --git a/hdf5-sys/src/h5f.rs b/hdf5-sys/src/h5f.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating HDF5 files
 use std::mem;
 
 pub use self::H5F_close_degree_t::*;
diff --git a/hdf5-sys/src/h5fd.rs b/hdf5-sys/src/h5fd.rs
@@ -1,3 +1,4 @@
+//! File drivers
 use std::mem;
 
 pub use self::H5FD_file_image_op_t::*;
diff --git a/hdf5-sys/src/h5g.rs b/hdf5-sys/src/h5g.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating groups of objects inside an HDF5 file
 use std::mem;
 
 pub use self::H5G_storage_type_t::*;
diff --git a/hdf5-sys/src/h5i.rs b/hdf5-sys/src/h5i.rs
@@ -1,3 +1,4 @@
+//! Manipulating object identifiers and object names
 pub use self::H5I_type_t::*;
 
 use crate::internal_prelude::*;
diff --git a/hdf5-sys/src/h5l.rs b/hdf5-sys/src/h5l.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating links within an HDF5 group
 use std::mem;
 
 pub use self::H5L_type_t::*;
diff --git a/hdf5-sys/src/h5mm.rs b/hdf5-sys/src/h5mm.rs
@@ -1,3 +1,4 @@
+//! Memory managment
 use crate::internal_prelude::*;
 
 pub type H5MM_allocate_t =
diff --git a/hdf5-sys/src/h5o.rs b/hdf5-sys/src/h5o.rs
@@ -1,3 +1,4 @@
+//! Manipulating objects in an HDF5 file
 use std::mem;
 
 pub use self::H5O_mcdt_search_ret_t::*;
diff --git a/hdf5-sys/src/h5p.rs b/hdf5-sys/src/h5p.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating property lists to control HDF5 library behaviour
 use crate::internal_prelude::*;
 
 use crate::h5ac::H5AC_cache_config_t;
diff --git a/hdf5-sys/src/h5pl.rs b/hdf5-sys/src/h5pl.rs
@@ -1,3 +1,4 @@
+//! Programmatically controlling dynamically loaded plugins
 use crate::internal_prelude::*;
 
 #[cfg(hdf5_1_8_15)]
diff --git a/hdf5-sys/src/h5r.rs b/hdf5-sys/src/h5r.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating references to specific objects and data regions in an HDF5 file
 pub use self::H5R_type_t::*;
 #[cfg(not(hdf5_1_10_0))]
 pub use H5Rdereference1 as H5Rdereference;
diff --git a/hdf5-sys/src/h5s.rs b/hdf5-sys/src/h5s.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating dataspaces in which to store elements of a dataset
 pub use self::H5S_class_t::*;
 pub use self::H5S_sel_type::*;
 pub use self::H5S_seloper_t::*;
diff --git a/hdf5-sys/src/h5t.rs b/hdf5-sys/src/h5t.rs
@@ -1,3 +1,4 @@
+//! Creating and manipulating datatypes which describe elements of a dataset
 use std::mem;
 
 pub use self::H5T_bkg_t::*;
diff --git a/hdf5-sys/src/h5vl.rs b/hdf5-sys/src/h5vl.rs
@@ -1,3 +1,4 @@
+//! Using the Virtual Object Layer
 #![cfg(hdf5_1_12_0)]
 use crate::internal_prelude::*;
 
diff --git a/hdf5-sys/src/h5z.rs b/hdf5-sys/src/h5z.rs
@@ -1,3 +1,4 @@
+//! Configuring filters that process data during I/O operation
 use std::mem;
 
 pub use self::H5Z_EDC_t::*;
diff --git a/hdf5-sys/src/lib.rs b/hdf5-sys/src/lib.rs
@@ -1,3 +1,4 @@
+//! Rust bindings to the `hdf5` library for reading and writing data to and from storage
 #![allow(non_camel_case_types, non_snake_case, dead_code, deprecated)]
 #![cfg_attr(feature = "cargo-clippy", allow(clippy::unreadable_literal))]
 #![cfg_attr(feature = "cargo-clippy", allow(clippy::missing_safety_doc))]
diff --git a/src/hl/container.rs b/src/hl/container.rs
@@ -1,3 +1,4 @@
+use std::convert::TryInto;
 use std::fmt::{self, Debug};
 use std::mem;
 use std::ops::Deref;
@@ -67,12 +68,13 @@ impl<'a> Reader<'a> {
     pub fn read_slice<T, S, D>(&self, selection: S) -> Result<Array<T, D>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
         D: ndarray::Dimension,
     {
         ensure!(!self.obj.is_attr(), "Slicing cannot be used on attribute datasets");
 
-        let selection = selection.into();
+        let selection = selection.try_into()?;
         let obj_space = self.obj.space()?;
 
         let out_shape = selection.out_shape(&obj_space.shape())?;
@@ -147,7 +149,8 @@ impl<'a> Reader<'a> {
     pub fn read_slice_1d<T, S>(&self, selection: S) -> Result<Array1<T>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
     {
         self.read_slice(selection)
     }
@@ -164,7 +167,8 @@ impl<'a> Reader<'a> {
     pub fn read_slice_2d<T, S>(&self, selection: S) -> Result<Array2<T>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
     {
         self.read_slice(selection)
     }
@@ -236,12 +240,13 @@ impl<'a> Writer<'a> {
     where
         A: Into<ArrayView<'b, T, D>>,
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
         D: ndarray::Dimension,
     {
         ensure!(!self.obj.is_attr(), "Slicing cannot be used on attribute datasets");
 
-        let selection = selection.into();
+        let selection = selection.try_into()?;
         let obj_space = self.obj.space()?;
 
         let out_shape = selection.out_shape(&obj_space.shape())?;
@@ -343,6 +348,7 @@ impl<'a> Writer<'a> {
 
 #[repr(transparent)]
 #[derive(Clone)]
+/// An object which can be read or written to.
 pub struct Container(Handle);
 
 impl ObjectClass for Container {
@@ -467,7 +473,8 @@ impl Container {
     pub fn read_slice_1d<T, S>(&self, selection: S) -> Result<Array1<T>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
     {
         self.as_reader().read_slice_1d(selection)
     }
@@ -484,7 +491,8 @@ impl Container {
     pub fn read_slice_2d<T, S>(&self, selection: S) -> Result<Array2<T>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
     {
         self.as_reader().read_slice_2d(selection)
     }
@@ -502,7 +510,8 @@ impl Container {
     pub fn read_slice<T, S, D>(&self, selection: S) -> Result<Array<T, D>>
     where
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
         D: ndarray::Dimension,
     {
         self.as_reader().read_slice(selection)
@@ -548,7 +557,8 @@ impl Container {
     where
         A: Into<ArrayView<'b, T, D>>,
         T: H5Type,
-        S: Into<Selection>,
+        S: TryInto<Selection>,
+        Error: From<S::Error>,
         D: ndarray::Dimension,
     {
         self.as_writer().write_slice(arr, selection)
diff --git a/src/hl/selection.rs b/src/hl/selection.rs
diff --git a/tests/test_plist.rs b/tests/test_plist.rs

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! General purpose library functions`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`pub use self::H5_index_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Creating and manipulating HDF5 attributes`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`use crate::internal_prelude::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Cache functions`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`use crate::internal_prelude::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Cache functionality`
`1`	`2`	`pub use self::H5C_cache_decr_mode::*;`
`2`	`3`	`pub use self::H5C_cache_flash_incr_mode::*;`
`3`	`4`	`pub use self::H5C_cache_incr_mode::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Creating and manipulating scientific datasets`
`1`	`2`	`pub use self::H5D_alloc_time_t::*;`
`2`	`3`	`pub use self::H5D_fill_time_t::*;`
`3`	`4`	`pub use self::H5D_fill_value_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Functions for handling errors that occur within HDF5`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`pub use self::H5E_direction_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Creating and manipulating HDF5 files`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`pub use self::H5F_close_degree_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! File drivers`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`pub use self::H5FD_file_image_op_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Creating and manipulating groups of objects inside an HDF5 file`
`1`	`2`	`use std::mem;`
`2`	`3`
`3`	`4`	`pub use self::H5G_storage_type_t::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//! Manipulating object identifiers and object names`
`1`	`2`	`pub use self::H5I_type_t::*;`
`2`	`3`
`3`	`4`	`use crate::internal_prelude::*;`