Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unread_decoded_data methods to decoders #72

Merged
merged 1 commit into from
May 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/deflate/decode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@ where
self.bit_reader.into_inner()
}

/// Returns the data that has been decoded but has not yet been read.
///
/// This method is useful to retrieve partial decoded data when the decoding process is failed.
pub fn unread_decoded_data(&self) -> &[u8] {
self.lz77_decoder.buffer()
}

pub(crate) fn reset(&mut self) {
self.bit_reader.reset();
self.lz77_decoder.clear();
Expand Down
7 changes: 7 additions & 0 deletions src/gzip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1011,6 +1011,13 @@ where
self.reader.into_inner()
}

/// Returns the data that has been decoded but has not yet been read.
///
/// This method is useful to retrieve partial decoded data when the decoding process is failed.
pub fn unread_decoded_data(&self) -> &[u8] {
self.reader.unread_decoded_data()
}

fn with_header(inner: R, header: Header) -> Self {
Decoder {
header,
Expand Down
26 changes: 26 additions & 0 deletions src/zlib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,13 @@ where
pub fn into_inner(self) -> R {
self.reader.into_inner()
}

/// Returns the data that has been decoded but has not yet been read.
///
/// This method is useful to retrieve partial decoded data when the decoding process is failed.
pub fn unread_decoded_data(&self) -> &[u8] {
self.reader.unread_decoded_data()
}
}
impl<R> io::Read for Decoder<R>
where
Expand Down Expand Up @@ -928,4 +935,23 @@ mod tests {
decoder.read_to_end(&mut buf).unwrap();
assert_eq!(buf, b"Hello World");
}

#[test]
fn issue71() {
let encoded_data = [
120, 218, 251, 255, 207, 144, 193, 138, 193, 151, 161, 146, 33, 143, 33, 149, 161, 156,
161, 24, 72, 38, 51, 148, 48, 100, 50, 228, 3, 69, 120, 25, 184, 24,
];

let mut decoder = Decoder::new(&encoded_data[..]).unwrap();
let mut buf = Vec::new();
let result = decoder.read_to_end(&mut buf);
assert!(result.is_err());

let decoded_data = [
255, 254, 49, 0, 58, 0, 77, 0, 121, 0, 110, 0, 101, 0, 119, 0, 115, 0, 101, 0, 99, 0,
116, 0, 105, 0, 111, 0, 110, 0, 13, 0, 10,
];
assert_eq!(decoder.unread_decoded_data(), decoded_data);
}
}