Extend the test

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        rust: ["1.76", stable, nightly]
+        rust: ["1.65", stable, nightly]
 
     steps:
       - name: Checkout the Repository
@@ -48,7 +48,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        rust: ["1.76", stable, nightly]
+        rust: ["1.65", stable, nightly]
         python: ["3.10", "3.11", "3.12"]
 
     steps:
@@ -103,7 +103,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        rust: ["1.76", stable]
+        rust: ["1.65", stable]
 
     steps:
       - name: Checkout the Repository

.gitignore

@@ -1 +1,2 @@
 /target
+/Cargo.lock

Cargo.toml

@@ -10,13 +10,14 @@ edition = "2021"
 authors = ["Juniper Tyree <[email protected]>"]
 repository = "https://github.com/juntyr/numcodecs-rs"
 license = "MPL-2.0"
-rust-version = "1.57"
+rust-version = "1.65"
 
 [workspace.dependencies]
 # workspace-internal crates
 numcodecs = { path = "crates/numcodecs-python", default-features = false }
 
 # crates.io third-party dependencies
+numpy = { version = "0.21", default-features = false }
 pyo3 = { version = "0.21", default-features = false }
 
 [workspace.lints.rust]

crates/numcodecs-python/Cargo.toml

@@ -18,6 +18,7 @@ keywords = ["numcodecs", "compression", "encoding", "python", "pyo3"]
 pyo3 = { workspace = true }
 
 [dev-dependencies]
+numpy = { workspace = true }
 pyo3 = { workspace = true, features = ["auto-initialize"] }
 
 [lints]

crates/numcodecs-python/src/lib.rs

@@ -27,20 +27,6 @@ impl Registry {
     ///
     /// Errors if no codec with a matching `id` has been registered, or if
     /// constructing the codec fails.
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// # use pyo3::{prelude::*, types::PyDict};
-    /// # use numcodecs_python::Registry;
-    ///
-    /// Python::with_gil(|py| {
-    ///     let config = PyDict::new_bound(py);
-    ///     config.set_item("id", "crc32");
-    ///
-    ///     let codec = Registry::get_codec(config.as_borrowed()).unwrap();
-    /// });
-    /// ```
     pub fn get_codec<'py>(config: Borrowed<'_, 'py, PyDict>) -> Result<Bound<'py, Codec>, PyErr> {
         static GET_CODEC: GILOnceCell<Py<PyAny>> = GILOnceCell::new();
 
@@ -96,7 +82,7 @@ impl Registry {
 /// [`numcodecs.abc.Codec`]: https://numcodecs.readthedocs.io/en/stable/abc.html#module-numcodecs.abc
 #[repr(transparent)]
 pub struct Codec {
-    codec: PyAny,
+    _codec: PyAny,
 }
 
 /// Methods implemented for [`Codec`]s.
@@ -230,7 +216,7 @@ unsafe impl PyTypeInfo for Codec {
 /// [`numcodecs.abc.Codec`]: https://numcodecs.readthedocs.io/en/stable/abc.html#module-numcodecs.abc
 #[repr(transparent)]
 pub struct CodecClass {
-    class: PyType,
+    _class: PyType,
 }
 
 /// Methods implemented for [`CodecClass`]es.
@@ -314,3 +300,47 @@ unsafe impl PyTypeInfo for CodecClass {
 mod sealed {
     pub trait Sealed {}
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn crc32() -> Result<(), PyErr> {
+        Python::with_gil(|py| {
+            let config = PyDict::new_bound(py);
+            config.set_item("id", "crc32")?;
+
+            let codec = Registry::get_codec(config.as_borrowed())?;
+            assert_eq!(codec.class().codec_id()?, "crc32");
+
+            let data = &[1, 2, 3, 4];
+
+            let encoded = codec.encode(
+                numpy::PyArray1::from_slice_bound(py, data)
+                    .as_any()
+                    .as_borrowed(),
+            )?;
+            let decoded = codec.decode(encoded.as_borrowed(), None)?;
+
+            let encoded: Vec<i32> = encoded.extract()?;
+            let decoded: Vec<i32> = decoded.extract()?;
+
+            assert_eq!(encoded, [123]);
+            assert_eq!(decoded, data);
+
+            let config = codec.get_config()?;
+            assert_eq!(config.len(), 1);
+            assert_eq!(
+                config
+                    .get_item("id")?
+                    .map(|i| i.extract::<String>())
+                    .transpose()?
+                    .as_deref(),
+                Some("crc32")
+            );
+
+            Ok(())
+        })
+    }
+}