From b20ada442706328293f4262b951fa9ee0f2926d2 Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Tue, 10 Nov 2020 17:12:27 +0000 Subject: [PATCH 1/2] feat: provide constants for compression methods --- src/compression.rs | 51 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/src/compression.rs b/src/compression.rs index 3183e851..6f91e9f0 100644 --- a/src/compression.rs +++ b/src/compression.rs @@ -10,7 +10,7 @@ use std::fmt; /// /// When creating ZIP files, you may choose the method to use with /// [`zip::write::FileOptions::compression_method`] -#[derive(Copy, Clone, PartialEq, Debug)] +#[derive(Copy, Clone, PartialEq, Eq, Debug)] pub enum CompressionMethod { /// Store the file as is Stored, @@ -25,18 +25,53 @@ pub enum CompressionMethod { #[cfg(feature = "bzip2")] Bzip2, /// Unsupported compression method - #[deprecated( - since = "0.5.7", - note = "implementation details are being removed from the public API" - )] + #[deprecated(since = "0.5.7", note = "use the constants instead")] Unsupported(u16), } - +#[allow(deprecated, missing_docs)] +/// All compression methods defined for the ZIP format +impl CompressionMethod { + pub const STORE: Self = Self::Stored; + pub const SHRINK: Self = Self::Unsupported(1); + pub const REDUCE_1: Self = Self::Unsupported(2); + pub const REDUCE_2: Self = Self::Unsupported(3); + pub const REDUCE_3: Self = Self::Unsupported(4); + pub const REDUCE_4: Self = Self::Unsupported(5); + pub const IMPLODE: Self = Self::Unsupported(6); + #[cfg(any( + feature = "deflate", + feature = "deflate-miniz", + feature = "deflate-zlib" + ))] + pub const DEFLATE: Self = Self::Deflated; + #[cfg(not(any( + feature = "deflate", + feature = "deflate-miniz", + feature = "deflate-zlib" + )))] + pub const DEFLATE: Self = Self::Unsupported(8); + pub const DEFLATE64: Self = Self::Unsupported(9); + pub const PKWARE_IMPLODE: Self = Self::Unsupported(10); + #[cfg(feature = "bzip2")] + pub const BZIP2: Self = Self::Bzip2; + #[cfg(not(feature = "bzip2"))] + pub const BZIP2: Self = Self::Unsupported(12); + pub const LZMA: Self = Self::Unsupported(14); + pub const IBM_ZOS_CMPSC: Self = Self::Unsupported(16); + pub const IBM_TERSE: Self = Self::Unsupported(18); + pub const ZSTD_DEPRECATED: Self = Self::Unsupported(20); + pub const ZSTD: Self = Self::Unsupported(93); + pub const MP3: Self = Self::Unsupported(94); + pub const XZ: Self = Self::Unsupported(95); + pub const JPEG: Self = Self::Unsupported(96); + pub const WAVPACK: Self = Self::Unsupported(97); + pub const PPMD: Self = Self::Unsupported(98); +} impl CompressionMethod { /// Converts an u16 to its corresponding CompressionMethod #[deprecated( since = "0.5.7", - note = "implementation details are being removed from the public API" + note = "use a constant to construct a compression method" )] pub fn from_u16(val: u16) -> CompressionMethod { #[allow(deprecated)] @@ -58,7 +93,7 @@ impl CompressionMethod { /// Converts a CompressionMethod to a u16 #[deprecated( since = "0.5.7", - note = "implementation details are being removed from the public API" + note = "to match on other compression methods, use a constant" )] pub fn to_u16(self) -> u16 { #[allow(deprecated)] From ac4f5b3ef5d557ea2d4af56c4536fcdc1e8fae52 Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Tue, 10 Nov 2020 17:32:14 +0000 Subject: [PATCH 2/2] fix: remove enum aliases this feature is unstable on 1.34.0 --- src/compression.rs | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/src/compression.rs b/src/compression.rs index 6f91e9f0..5fdde070 100644 --- a/src/compression.rs +++ b/src/compression.rs @@ -31,41 +31,41 @@ pub enum CompressionMethod { #[allow(deprecated, missing_docs)] /// All compression methods defined for the ZIP format impl CompressionMethod { - pub const STORE: Self = Self::Stored; - pub const SHRINK: Self = Self::Unsupported(1); - pub const REDUCE_1: Self = Self::Unsupported(2); - pub const REDUCE_2: Self = Self::Unsupported(3); - pub const REDUCE_3: Self = Self::Unsupported(4); - pub const REDUCE_4: Self = Self::Unsupported(5); - pub const IMPLODE: Self = Self::Unsupported(6); + pub const STORE: Self = CompressionMethod::Stored; + pub const SHRINK: Self = CompressionMethod::Unsupported(1); + pub const REDUCE_1: Self = CompressionMethod::Unsupported(2); + pub const REDUCE_2: Self = CompressionMethod::Unsupported(3); + pub const REDUCE_3: Self = CompressionMethod::Unsupported(4); + pub const REDUCE_4: Self = CompressionMethod::Unsupported(5); + pub const IMPLODE: Self = CompressionMethod::Unsupported(6); #[cfg(any( feature = "deflate", feature = "deflate-miniz", feature = "deflate-zlib" ))] - pub const DEFLATE: Self = Self::Deflated; + pub const DEFLATE: Self = CompressionMethod::Deflated; #[cfg(not(any( feature = "deflate", feature = "deflate-miniz", feature = "deflate-zlib" )))] - pub const DEFLATE: Self = Self::Unsupported(8); - pub const DEFLATE64: Self = Self::Unsupported(9); - pub const PKWARE_IMPLODE: Self = Self::Unsupported(10); + pub const DEFLATE: Self = CompressionMethod::Unsupported(8); + pub const DEFLATE64: Self = CompressionMethod::Unsupported(9); + pub const PKWARE_IMPLODE: Self = CompressionMethod::Unsupported(10); #[cfg(feature = "bzip2")] - pub const BZIP2: Self = Self::Bzip2; + pub const BZIP2: Self = CompressionMethod::Bzip2; #[cfg(not(feature = "bzip2"))] - pub const BZIP2: Self = Self::Unsupported(12); - pub const LZMA: Self = Self::Unsupported(14); - pub const IBM_ZOS_CMPSC: Self = Self::Unsupported(16); - pub const IBM_TERSE: Self = Self::Unsupported(18); - pub const ZSTD_DEPRECATED: Self = Self::Unsupported(20); - pub const ZSTD: Self = Self::Unsupported(93); - pub const MP3: Self = Self::Unsupported(94); - pub const XZ: Self = Self::Unsupported(95); - pub const JPEG: Self = Self::Unsupported(96); - pub const WAVPACK: Self = Self::Unsupported(97); - pub const PPMD: Self = Self::Unsupported(98); + pub const BZIP2: Self = CompressionMethod::Unsupported(12); + pub const LZMA: Self = CompressionMethod::Unsupported(14); + pub const IBM_ZOS_CMPSC: Self = CompressionMethod::Unsupported(16); + pub const IBM_TERSE: Self = CompressionMethod::Unsupported(18); + pub const ZSTD_DEPRECATED: Self = CompressionMethod::Unsupported(20); + pub const ZSTD: Self = CompressionMethod::Unsupported(93); + pub const MP3: Self = CompressionMethod::Unsupported(94); + pub const XZ: Self = CompressionMethod::Unsupported(95); + pub const JPEG: Self = CompressionMethod::Unsupported(96); + pub const WAVPACK: Self = CompressionMethod::Unsupported(97); + pub const PPMD: Self = CompressionMethod::Unsupported(98); } impl CompressionMethod { /// Converts an u16 to its corresponding CompressionMethod