Codes index

.github/workflows/rust-dev.yml

@@ -23,13 +23,13 @@ jobs:
         cargo clean
     - name: Test with cargo
       run: |
-        RUST_BACKTRACE=full cargo test
+        RUST_BACKTRACE=full cargo test --features "experimental_index"
     - name: Check with clippy
       run: |
-        cargo clippy -- -W clippy::pedantic
+        cargo clippy --features "experimental_index"
     - name: Build release
       run: |
-        cargo build --release
+        cargo build --release --features "experimental_index"
 
   build-macos:
 
@@ -45,10 +45,10 @@ jobs:
         cargo clean
     - name: Test with cargo
       run: |
-        RUST_BACKTRACE=full cargo test
+        RUST_BACKTRACE=full cargo test --features "experimental_index"
     - name: Check with clippy
       run: |
-        cargo clippy -- -W clippy::pedantic
+        cargo clippy --features "experimental_index"
     - name: Build release
       run: |
-        cargo build --release
+        cargo build --release --features "experimental_index"

.github/workflows/rust.yml

@@ -27,11 +27,11 @@ jobs:
         cargo clean
     - name: Build with cargo
       run: |
-        cargo build --release
+        cargo build --release --features "experimental_index"
         cargo clean
     - name: Test with cargo
       run: |
-        cargo test
+        cargo test --features "experimental_index"
         cargo clean
     - name: Benchmark with criterion
       run: |
@@ -53,11 +53,11 @@ jobs:
         cargo clean
     - name: Build with cargo
       run: |
-        cargo build --release
+        cargo build --release --features "experimental_index"
         cargo clean
     - name: Test with cargo
       run: |
-        cargo test
+        cargo test --features "experimental_index"
         cargo clean
     - name: Benchmark with criterion
       run: |

Cargo.toml

@@ -2,7 +2,7 @@
 name = "eccodes"
 description = "Unofficial high-level Rust bindings of the latest ecCodes release"
 repository = "https://github.com/ScaleWeather/eccodes"
-version = "0.8.0"
+version = "0.9.0"
 readme = "README.md"
 authors = ["Jakub Lewandowski <[email protected]>"]
 keywords = ["eccodes", "grib", "bufr", "meteorology", "weather"]
@@ -18,7 +18,7 @@ edition = "2021"
 exclude = [".github/*", ".vscode/*", ".idea/*", "data/*"]
 
 [dependencies]
-eccodes-sys = "0.5.1"
+eccodes-sys = "0.5.2"
 libc = "0.2"
 thiserror = "1.0"
 bytes = "1.5"
@@ -29,17 +29,18 @@ num-traits = "0.2"
 fallible-iterator = "0.3"
 
 [dev-dependencies]
-eccodes-sys = "0.5.1"
 reqwest = { version = "0.11", features = ["rustls-tls"] }
 tokio = { version = "1.35", features = ["macros", "rt"] }
 criterion = "0.5"
 testing_logger = "0.1"
+rand = "0.8"
 
 [features]
 docs = ["eccodes-sys/docs"]
+experimental_index = []
 
 [package.metadata.docs.rs]
-features = ["docs"]
+features = ["docs", "experimental_index"]
 
 [[bench]]
 name = "main"

src/codes_handle/iterator.rs

@@ -9,6 +9,10 @@ use crate::{
         codes_handle_new_from_message_copy,
     },
 };
+#[cfg(feature = "experimental_index")]
+use crate::{intermediate_bindings::codes_index::codes_handle_new_from_index, CodesIndex};
+
+use super::GribFile;
 
 ///`FallibleIterator` implementation for `CodesHandle` to access GRIB messages inside file.
 ///
@@ -18,7 +22,7 @@ use crate::{
 ///Therefore this crate utilizes the `Iterator` to provide the access to GRIB messages in
 ///a safe and convienient way.
 ///
-///[`FallibleIterator`](fallible_iterator::FallibleIterator) is used instead of classic `Iterator`
+///[`FallibleIterator`] is used instead of classic `Iterator`
 ///because internal ecCodes functions can return error codes when the GRIB file
 ///is corrupted and for some other reasons. The usage of `FallibleIterator` is sligthly different
 ///than usage of `Iterator`, check its documentation for more details.
@@ -77,23 +81,52 @@ use crate::{
 ///## Errors
 ///The `next()` method will return [`CodesInternal`](crate::errors::CodesInternal)
 ///when internal ecCodes function returns non-zero code.
-impl FallibleIterator for CodesHandle {
+impl FallibleIterator for CodesHandle<GribFile> {
+    type Item = KeyedMessage;
+
+    type Error = CodesError;
+
+    fn next(&mut self) -> Result<Option<Self::Item>, Self::Error> {
+        let new_eccodes_handle;
+        unsafe {
+            codes_handle_delete(self.eccodes_handle)?;
+            new_eccodes_handle = codes_handle_new_from_file(self.source.pointer, self.product_kind);
+        }
+
+        match new_eccodes_handle {
+            Ok(h) => {
+                self.eccodes_handle = h;
+
+                if self.eccodes_handle.is_null() {
+                    Ok(None)
+                } else {
+                    let message = get_message_from_handle(h);
+                    Ok(Some(message))
+                }
+            }
+            Err(e) => Err(e),
+        }
+    }
+}
+
+#[cfg(feature = "experimental_index")]
+impl FallibleIterator for CodesHandle<CodesIndex> {
     type Item = KeyedMessage;
 
     type Error = CodesError;
 
     fn next(&mut self) -> Result<Option<Self::Item>, Self::Error> {
-        let file_handle;
+        let new_eccodes_handle;
         unsafe {
-            codes_handle_delete(self.file_handle)?;
-            file_handle = codes_handle_new_from_file(self.file_pointer, self.product_kind);
+            codes_handle_delete(self.eccodes_handle)?;
+            new_eccodes_handle = codes_handle_new_from_index(self.source.pointer);
         }
 
-        match file_handle {
+        match new_eccodes_handle {
             Ok(h) => {
-                self.file_handle = h;
+                self.eccodes_handle = h;
 
-                if self.file_handle.is_null() {
+                if self.eccodes_handle.is_null() {
                     Ok(None)
                 } else {
                     let message = get_message_from_handle(h);

src/codes_handle/keyed_message/iterator.rs

@@ -18,7 +18,7 @@ use super::KeysIteratorFlags;
 ///so it is probably more efficient to call that function directly only for keys you
 ///are interested in.
 ///
-///[`FallibleIterator`](fallible_iterator::FallibleIterator) is used instead of classic `Iterator`
+///[`FallibleIterator`] is used instead of classic `Iterator`
 ///because internal ecCodes functions can return internal error in some edge-cases.
 ///The usage of `FallibleIterator` is sligthly different than usage of `Iterator`,
 ///check its documentation for more details.

src/codes_handle/keyed_message/mod.rs

@@ -122,7 +122,7 @@ impl Drop for KeyedMessage {
     ///Technical note: delete functions in ecCodes can only fail with [`CodesInternalError`](crate::errors::CodesInternal::CodesInternalError)
     ///when other functions corrupt the inner memory of pointer, in that case memory leak is possible.
     ///In case of corrupt pointer segmentation fault will occur.
-    ///The pointers are cleared at the end of drop as they ar not not functional despite the result of delete functions.
+    ///The pointers are cleared at the end of drop as they are not functional despite the result of delete functions.
     fn drop(&mut self) {
         if let Some(nrst) = self.nearest_handle {
             unsafe {