MOD: Deprecate Tar packaging option

databento · Sep 24, 2024 · 73f627c · 73f627c
1 parent 2acabfd
commit 73f627c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.13.0 - TBD
+
+#### Deprecations
+- Deprecated `Packaging::Tar`. Users should switch to `Packaging::Zip`. This variant
+  will be removed in a future version when it is no longer supported by the API
+
 ## 0.12.1 - 2024-08-27
 
 #### Enhancements

diff --git a/src/historical/batch.rs b/src/historical/batch.rs
@@ -213,6 +213,7 @@ pub enum Packaging {
     /// ZIP compressed.
     Zip,
     /// Tarball.
+    #[deprecated(since = "0.13.0", note = "Users should use Zip instead")]
     Tar,
 }
 
@@ -475,6 +476,7 @@ impl Packaging {
     pub const fn as_str(&self) -> &'static str {
         match self {
             Packaging::Zip => "zip",
+            #[allow(deprecated)]
             Packaging::Tar => "tar",
         }
     }
@@ -492,6 +494,7 @@ impl FromStr for Packaging {
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match s {
             "zip" => Ok(Packaging::Zip),
+            #[allow(deprecated)]
             "tar" => Ok(Packaging::Tar),
             _ => Err(crate::Error::bad_arg(
                 "s",