feat: LZMA compression method (#41)

Using lzma-rs, a pure Rust LZMA implementation, because nothing else worked.

Author: fasterthanlime

.direnv/flake-profile

@@ -0,0 +1 @@
+flake-profile-1-link

.direnv/flake-profile-1-link

@@ -0,0 +1 @@
+/nix/store/bdw4nizg6fg6i13gyi43skk3clwg7fjs-nix-shell-env

.envrc

@@ -0,0 +1 @@
+use flake

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"rust-analyzer.cargo.features": ["default", "lzma"]
+}

Cargo.lock

@@ -14,3 +14,8 @@ humansize = "2.1.3"
 positioned-io.workspace = true
 indicatif = "0.17.7"
 tracing-subscriber = "0.3.18"
+
+[features]
+default = ["lzma"]
+deflate = ["rc-zip/deflate"]
+lzma = ["rc-zip/lzma"]

crates/jean/Cargo.toml

@@ -25,9 +25,16 @@ thiserror = "1.0.56"
 chardetng = "0.1.17"
 flate2 = { version = "1.0.28", optional = true }
 num_enum = "0.7.2"
+byteorder = "1.5.0"
+cfg-if = "1.0.0"
+lzma-rs = { version = "0.3.0", features = ["stream"], optional = true }
 
 [features]
 default = ["sync", "file", "deflate"]
 sync = []
 file = ["positioned-io"]
 deflate = ["flate2"]
+lzma = ["lzma-rs"]
+
+[dev-dependencies]
+tracing-test = "0.2.4"

crates/rc-zip/Cargo.toml

@@ -1,3 +1,5 @@
+use crate::Method;
+
 use super::encoding;
 
 /// Any zip-related error, from invalid archives to encoding problems.
@@ -24,12 +26,30 @@ pub enum Error {
     UnknownSize,
 }
 
+impl Error {
+    #[allow(unused)]
+    pub(crate) fn method_not_supported(method: Method) -> Self {
+        Self::Unsupported(UnsupportedError::MethodNotSupported(method))
+    }
+
+    #[allow(unused)]
+    pub(crate) fn method_not_enabled(method: Method) -> Self {
+        Self::Unsupported(UnsupportedError::MethodNotEnabled(method))
+    }
+}
+
 #[derive(Debug, thiserror::Error)]
 pub enum UnsupportedError {
-    #[error("unsupported compression method: {0:?}")]
-    UnsupportedCompressionMethod(crate::format::Method),
+    #[error("compression method not supported: {0:?}")]
+    MethodNotSupported(crate::format::Method),
+
     #[error("compression method supported, but not enabled in this build: {0:?}")]
-    CompressionMethodNotEnabled(crate::format::Method),
+    MethodNotEnabled(crate::format::Method),
+
+    #[error("only LZMA2.0 is supported, found LZMA{minor}.{major}")]
+    LzmaVersionUnsupported { minor: u8, major: u8 },
+    #[error("LZMA properties header wrong size: expected {expected} bytes, got {actual} bytes")]
+    LzmaPropertiesHeaderWrongSize { expected: u16, actual: u16 },
 }
 
 /// Specific zip format errors, mostly due to invalid zip archives but that could also stem from
@@ -93,6 +113,9 @@ pub enum FormatError {
     /// The CRC-32 checksum didn't match.
     #[error("checksum didn't match: expected {expected:x?}, got {actual:x?}")]
     WrongChecksum { expected: u32, actual: u32 },
+
+    #[error("lzma properties larger than max")]
+    LzmaPropertiesLargerThanMax,
 }
 
 impl From<Error> for std::io::Error {

crates/rc-zip/src/error.rs

@@ -116,7 +116,9 @@ pub struct StoredEntry {
     ///
     /// In the zip format, the most noteworthy flag (bit 11) is for UTF-8 names.
     /// Other flags can indicate: encryption (unsupported), various compression
-    /// settings (depending on the [Method][] used).
+    /// settings (depending on the [Method] used).
+    ///
+    /// For LZMA, general-purpose bit 1 denotes the EOS marker.
     pub flags: u16,
 
     /// Unix user ID

crates/rc-zip/src/format/archive.rs

@@ -1,6 +1,3 @@
-#[cfg(feature = "deflate")]
-use flate2::read::DeflateDecoder;
-
 use std::{cmp, io};
 
 pub trait Decoder<R>: io::Read
@@ -15,20 +12,6 @@ where
     fn get_mut(&mut self) -> &mut R;
 }
 
-#[cfg(feature = "deflate")]
-impl<R> Decoder<R> for DeflateDecoder<R>
-where
-    R: io::Read,
-{
-    fn into_inner(self: Box<Self>) -> R {
-        DeflateDecoder::into_inner(*self)
-    }
-
-    fn get_mut(&mut self) -> &mut R {
-        DeflateDecoder::get_mut(self)
-    }
-}
-
 pub struct StoreDecoder<R>
 where
     R: io::Read,