From 807c0e2d974b00146a0864f483c8daded3557a40 Mon Sep 17 00:00:00 2001
From: Jonathan Behrens <fintelia@gmail.com>
Date: Mon, 30 Dec 2024 12:41:03 -0800
Subject: [PATCH] Make flate2 a feature flag

---
 Cargo.toml     |  6 +++++-
 src/common.rs  | 15 ++++++++++++---
 src/encoder.rs | 20 ++++++++++++++++----
 src/lib.rs     |  1 +
 4 files changed, 34 insertions(+), 8 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 7bc7e240..bf8bda32 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -39,9 +39,13 @@ rand = "0.8.4"
 term = "1.0.1"
 
 [features]
-unstable = ["crc32fast/nightly"]
+flate2 = [] # Expose flate2 specific functionality
+unstable = ["crc32fast/nightly"] # Enable nightly-only features
 benchmarks = []
 
+[package.metadata.docs.rs]
+features = ["flate2"]
+
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(fuzzing)'] }
 
diff --git a/src/common.rs b/src/common.rs
index 8abc273b..67f2e485 100644
--- a/src/common.rs
+++ b/src/common.rs
@@ -378,10 +378,19 @@ pub enum DeflateCompression {
     /// while still providing a decent compression ratio.
     FdeflateUltraFast,
 
+    /// Compression level between 0 to 9, where higher values mean better compression at the cost of
+    /// speed.
+    ///
+    /// The precise meaning of each level depends the internal impementation and may change in the
+    /// future. If you want to ensure that the `flate2`` backend is used, you can use the
+    /// [`Flate2``] variant instead.
+    Level(u8),
+
     /// Uses [flate2](https://crates.io/crates/flate2) crate with the specified [compression level](flate2::Compression::new).
     ///
     /// Flate2 has several backends that make different trade-offs.
     /// See the flate2 documentation for the available backends for more information.
+    #[cfg(feature = "flate2")]
     Flate2(u8),
     // Other variants can be added in the future
 }
@@ -398,8 +407,8 @@ impl DeflateCompression {
             Compression::NoCompression => Self::NoCompression,
             Compression::Fastest => Self::FdeflateUltraFast,
             Compression::Fast => Self::FdeflateUltraFast,
-            Compression::Balanced => Self::Flate2(flate2::Compression::default().level() as u8),
-            Compression::High => Self::Flate2(flate2::Compression::best().level() as u8),
+            Compression::Balanced => Self::Level(flate2::Compression::default().level() as u8),
+            Compression::High => Self::Level(flate2::Compression::best().level() as u8),
         }
     }
 
@@ -407,7 +416,7 @@ impl DeflateCompression {
         match self {
             DeflateCompression::NoCompression => flate2::Compression::none(),
             DeflateCompression::FdeflateUltraFast => flate2::Compression::new(1),
-            DeflateCompression::Flate2(level) => flate2::Compression::new(u32::from(*level)),
+            DeflateCompression::Level(level) => flate2::Compression::new(u32::from(*level)),
         }
     }
 }
diff --git a/src/encoder.rs b/src/encoder.rs
index ac23a68e..15a4e7e1 100644
--- a/src/encoder.rs
+++ b/src/encoder.rs
@@ -782,7 +782,15 @@ impl<W: Write> Writer<W> {
         let bpp = self.info.bpp_in_prediction();
         let filter_method = self.options.filter;
 
-        let zlib_encoded = match self.options.compression {
+        #[allow(unused_mut)]
+        let mut compression = self.options.compression;
+
+        #[cfg(feature = "flate2")]
+        if let DeflateCompression::Flate2(level) = compression {
+            compression = DeflateCompression::Level(level);
+        }
+
+        let zlib_encoded = match compression {
             DeflateCompression::NoCompression => {
                 let mut compressor =
                     fdeflate::StoredOnlyCompressor::new(std::io::Cursor::new(Vec::new()))?;
@@ -823,7 +831,7 @@ impl<W: Write> Writer<W> {
                     compressed
                 }
             }
-            DeflateCompression::Flate2(level) => {
+            DeflateCompression::Level(level) => {
                 let mut current = vec![0; in_len];
 
                 let mut zlib =
@@ -837,6 +845,10 @@ impl<W: Write> Writer<W> {
                 }
                 zlib.finish()?
             }
+            #[cfg(feature = "flate2")]
+            DeflateCompression::Flate2(level) => {
+                unreachable!("Flate2 is handled by the Level variant")
+            }
         };
 
         match self.info.frame_control {
@@ -1772,7 +1784,7 @@ mod tests {
                 let mut buf = vec![0; reader.output_buffer_size()];
                 let info = reader.next_frame(&mut buf).unwrap();
                 use DeflateCompression::*;
-                for compression in [NoCompression, FdeflateUltraFast, Flate2(4)] {
+                for compression in [NoCompression, FdeflateUltraFast, Level(4)] {
                     // Encode decoded image
                     let mut out = Vec::new();
                     {
@@ -1830,7 +1842,7 @@ mod tests {
                 let mut buf = vec![0; reader.output_buffer_size()];
                 let info = reader.next_frame(&mut buf).unwrap();
                 use DeflateCompression::*;
-                for compression in [NoCompression, FdeflateUltraFast, Flate2(4)] {
+                for compression in [NoCompression, FdeflateUltraFast, Level(4)] {
                     // Encode decoded image
                     let mut out = Vec::new();
                     {
diff --git a/src/lib.rs b/src/lib.rs
index 6e6c3e9b..ae70d5c3 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -58,6 +58,7 @@
 //! ```
 //!
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![cfg_attr(feature = "unstable", feature(portable_simd))]
 #![forbid(unsafe_code)]