FIX: Make AsyncRecordDecoder cancel-safe

CHANGELOG.md

@@ -22,6 +22,11 @@
   the latest version
 - Added `-u`/`--upgrade` flags to `dbn` CLI that when passed upgrades DBN data from
   previous versions. By default data is decoded as-is
+- Made `AsyncDbnDecoder::decode_record`, `AsyncDbnDecoder::decode_record_ref`,
+  `dbn::AsyncRecordDecoder::decode`, and `dbn::AsyncRecordDecoder::decode_ref`
+  cancellation safe. This makes them safe to use within a
+  `tokio::select!`(https://docs.rs/tokio/latest/tokio/macro.select.html) statement
+- Added documention around cancellation safety for async APIs
 - Added `TOB` flag to denote top-of-book messages
 - Added new publisher values in preparation for IFEU.IMPACT and NDEX.IMPACT datasets
 - Added new publisher values for consolidated DBEQ.BASIC and DBEQ.PLUS

rust/dbn-cli/tests/integration_tests.rs

@@ -81,7 +81,7 @@ fn read_from_nonexistent_path() {
         ])
         .assert()
         .failure()
-        .stderr(contains("Error opening file to decode"));
+        .stderr(contains("while opening file to decode"));
 }
 
 #[rstest]

rust/dbn/src/decode.rs

@@ -207,7 +207,7 @@ where
                 )?,
             )))
         } else {
-            Err(crate::Error::decode("Unable to determine encoding"))
+            Err(crate::Error::decode("unable to determine encoding"))
         }
     }
 }
@@ -227,7 +227,7 @@ impl<'a> DynDecoder<'a, BufReader<File>> {
             crate::Error::io(
                 e,
                 format!(
-                    "Error opening file to decode at path '{}'",
+                    "opening file to decode at path '{}'",
                     path.as_ref().display()
                 ),
             )
@@ -382,7 +382,7 @@ impl<'a> DynReader<'a, BufReader<File>> {
             crate::Error::io(
                 e,
                 format!(
-                    "Error opening file to decode at path '{}'",
+                    "opening file to decode at path '{}'",
                     path.as_ref().display()
                 ),
             )
@@ -505,7 +505,7 @@ mod tests {
         let res = DynDecoder::new_inferred(io::Cursor::new(buf), VersionUpgradePolicy::default());
         assert!(matches!(res, Err(e) if e
             .to_string()
-            .contains("Can't decode newer version of DBN")));
+            .contains("can't decode newer version of DBN")));
     }
 }