Rename zarrsCreateArrayRWWithMetadata to zarrsCreateArrayRW and `…

…zarrsCreateArrayRW` to `zarrsOpenArrayRW`
LDeakin · Jun 23, 2024 · 625cbb8 · 625cbb8
1 parent f9384e2
commit 625cbb8
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
  - Make `cbindgen` dependency optional
+ - **Breaking**: Rename `zarrsCreateArrayRWWithMetadata` to `zarrsCreateArrayRW` and `zarrsCreateArrayRW` to `zarrsOpenArrayRW`
 
 ## [0.6.2] - 2024-04-20
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "zarrs_ffi"
 description = "FFI bindings for the zarrs crate"
-version = "0.6.2"
+version = "0.7.0"
 authors = ["Lachlan Deakin <ljdgit@gmail.com>"]
 edition = "2021"
 rust-version = "1.71"

diff --git a/examples/array_write_read.cpp b/examples/array_write_read.cpp
@@ -70,7 +70,7 @@ int main() {
   assert(storage);
 
   ZarrsArray array = nullptr;
-  zarrs_assert(zarrsCreateArrayRWWithMetadata(storage, "/array", metadata, &array));
+  zarrs_assert(zarrsCreateArrayRW(storage, "/array", metadata, &array));
   assert(array);
 
   size_t dimensionality;

diff --git a/src/array.rs b/src/array.rs
@@ -70,7 +70,7 @@ pub type ZarrsArray = *mut ZarrsArray_T;
 /// # Safety
 /// `pArray` must be a valid pointer to a `ZarrsArray` handle.
 #[no_mangle]
-pub unsafe extern "C" fn zarrsCreateArrayRW(
+pub unsafe extern "C" fn zarrsOpenArrayRW(
     storage: ZarrsStorage,
     path: FfiStr,
     pArray: *mut ZarrsArray,
@@ -107,7 +107,7 @@ pub unsafe extern "C" fn zarrsCreateArrayRW(
 /// # Safety
 /// `pArray` must be a valid pointer to a `ZarrsArray` handle.
 #[no_mangle]
-pub unsafe extern "C" fn zarrsCreateArrayRWWithMetadata(
+pub unsafe extern "C" fn zarrsCreateArrayRW(
     storage: ZarrsStorage,
     path: FfiStr,
     metadata: FfiStr,

diff --git a/src/lib.rs b/src/lib.rs
@@ -20,7 +20,7 @@ pub use array::{
     zarrsArrayGetChunkGridShape, zarrsArrayGetChunkOrigin, zarrsArrayGetChunkShape,
     zarrsArrayGetChunkSize, zarrsArrayGetChunksInSubset, zarrsArrayGetDataType,
     zarrsArrayGetDimensionality, zarrsArrayGetShape, zarrsArrayGetSubsetSize, zarrsCreateArrayRW,
-    zarrsCreateArrayRWWithMetadata, zarrsDestroyArray, ZarrsArray,
+    zarrsDestroyArray, zarrsOpenArrayRW, ZarrsArray,
 };
 pub use storage::{zarrsCreateStorageFilesystem, zarrsDestroyStorage, ZarrsStorage};
 pub use version::{zarrsVersion, zarrsVersionMajor, zarrsVersionMinor, zarrsVersionPatch};

diff --git a/tests/array_read.cpp b/tests/array_read.cpp
@@ -10,7 +10,7 @@ int main() {
   assert(storage);
 
   ZarrsArray array = nullptr;
-  zarrs_assert(zarrsCreateArrayRW(storage, "/array", &array));
+  zarrs_assert(zarrsOpenArrayRW(storage, "/array", &array));
   assert(array);
 
   // Update a subset

diff --git a/zarrs.h b/zarrs.h
@@ -302,16 +302,6 @@ ZarrsResult zarrsArrayStoreSubset(ZarrsArray array,
                                   size_t subsetBytesCount,
                                   const uint8_t *pSubsetBytes);
 
-/**
- * Create a handle to an existing array (read/write capability).
- *
- * `pArray` is a pointer to a handle in which the created `ZarrsArray` is returned.
- *
- * # Safety
- * `pArray` must be a valid pointer to a `ZarrsArray` handle.
- */
-ZarrsResult zarrsCreateArrayRW(ZarrsStorage storage, const char* path, ZarrsArray *pArray);
-
 /**
  * Create a handle to a new array (read/write capability).
  *
@@ -321,10 +311,10 @@ ZarrsResult zarrsCreateArrayRW(ZarrsStorage storage, const char* path, ZarrsArra
  * # Safety
  * `pArray` must be a valid pointer to a `ZarrsArray` handle.
  */
-ZarrsResult zarrsCreateArrayRWWithMetadata(ZarrsStorage storage,
-                                           const char* path,
-                                           const char* metadata,
-                                           ZarrsArray *pArray);
+ZarrsResult zarrsCreateArrayRW(ZarrsStorage storage,
+                               const char* path,
+                               const char* metadata,
+                               ZarrsArray *pArray);
 
 /**
  * Create a storage handle to a filesystem store.
@@ -363,6 +353,16 @@ ZarrsResult zarrsDestroyStorage(ZarrsStorage storage);
  */
 const char *zarrsLastError(void);
 
+/**
+ * Create a handle to an existing array (read/write capability).
+ *
+ * `pArray` is a pointer to a handle in which the created `ZarrsArray` is returned.
+ *
+ * # Safety
+ * `pArray` must be a valid pointer to a `ZarrsArray` handle.
+ */
+ZarrsResult zarrsOpenArrayRW(ZarrsStorage storage, const char* path, ZarrsArray *pArray);
+
 /**
  * Get the zarrs version.
  *