Fixup: raise error and docs update

src/brotli.rs

@@ -80,9 +80,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

src/deflate.rs

@@ -81,9 +81,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

src/gzip.rs

@@ -80,9 +80,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

src/io.rs

@@ -5,7 +5,7 @@
 use std::fs::{File, OpenOptions};
 use std::io::{copy, Cursor, Read, Seek, SeekFrom, Write};
 
-use crate::exceptions::{CompressionError, DecompressionError};
+use crate::exceptions::CompressionError;
 use crate::BytesType;
 use numpy::PyArray1;
 use pyo3::class::buffer::PyBufferProtocol;
@@ -606,7 +606,7 @@ pub(crate) fn stream_compress<W: Write>(inner: &mut Option<W>, input: &[u8]) ->
             let result = std::io::copy(&mut Cursor::new(input), inner).map(|v| v as usize);
             crate::to_py_err!(CompressionError -> result)
         }
-        None => Err(DecompressionError::new_err(
+        None => Err(CompressionError::new_err(
             "Compressor looks to have been consumed via `finish()`. \
             please create a new compressor instance.",
         )),

src/lz4.rs

@@ -146,9 +146,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

src/snappy.rs

@@ -147,9 +147,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

src/zstd.rs

@@ -79,9 +79,6 @@ impl Compressor {
     /// Consume the current compressor state and return the compressed stream
     /// **NB** The compressor will not be usable after this method is called.
     pub fn finish(&mut self) -> PyResult<RustyBuffer> {
-        // presently, pyo3 won't accept consuming an object, ie `finish(self)`
-        // so instead we're going to swap out whatever `inner` is, to allow
-        // consuming it.
         let mut inner = None;
         std::mem::swap(&mut inner, &mut self.inner);
 

tests/test_variants.py

@@ -263,3 +263,7 @@ def test_streams_compressor(mod):
     # just empty bytes after the first .finish()
     # same behavior as brotli.Compressor()
     assert bytes(compressor.finish()) == b""
+
+    # compress will raise an error as the stream is completed
+    with pytest.raises(cramjam.CompressionError):
+        compressor.compress(b'data')