summaryrefslogtreecommitdiff
path: root/vendor/weezl/src/error.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/weezl/src/error.rs')
-rw-r--r--vendor/weezl/src/error.rs72
1 files changed, 72 insertions, 0 deletions
diff --git a/vendor/weezl/src/error.rs b/vendor/weezl/src/error.rs
new file mode 100644
index 0000000..38dd95c
--- /dev/null
+++ b/vendor/weezl/src/error.rs
@@ -0,0 +1,72 @@
+/// The result of a coding operation on a pair of buffer.
+#[must_use = "Contains a status with potential error information"]
+pub struct BufferResult {
+ /// The number of bytes consumed from the input buffer.
+ pub consumed_in: usize,
+ /// The number of bytes written into the output buffer.
+ pub consumed_out: usize,
+ /// The status after returning from the write call.
+ pub status: Result<LzwStatus, LzwError>,
+}
+
+/// The result of a coding operation into a vector.
+#[must_use = "Contains a status with potential error information"]
+pub struct VectorResult {
+ /// The number of bytes consumed from the input buffer.
+ pub consumed_in: usize,
+ /// The number of bytes written into the output buffer.
+ pub consumed_out: usize,
+ /// The status after returning from the write call.
+ pub status: Result<LzwStatus, LzwError>,
+}
+
+/// The result of coding into an output stream.
+#[cfg(feature = "std")]
+#[must_use = "Contains a status with potential error information"]
+pub struct StreamResult {
+ /// The total number of bytes consumed from the reader.
+ pub bytes_read: usize,
+ /// The total number of bytes written into the writer.
+ pub bytes_written: usize,
+ /// The possible error that occurred.
+ ///
+ /// Note that when writing into streams it is not in general possible to recover from an error.
+ pub status: std::io::Result<()>,
+}
+
+/// The status after successful coding of an LZW stream.
+#[derive(Debug, Clone, Copy)]
+pub enum LzwStatus {
+ /// Everything went well.
+ Ok,
+ /// No bytes were read or written and no internal state advanced.
+ ///
+ /// If this is returned but your application can not provide more input data then decoding is
+ /// definitely stuck for good and it should stop trying and report some error of its own. In
+ /// other situations this may be used as a signal to refill an internal buffer.
+ NoProgress,
+ /// No more data will be produced because an end marker was reached.
+ Done,
+}
+
+/// The error kind after unsuccessful coding of an LZW stream.
+#[derive(Debug, Clone, Copy)]
+pub enum LzwError {
+ /// The input contained an invalid code.
+ ///
+ /// For decompression this refers to a code larger than those currently known through the prior
+ /// decoding stages. For compression this refers to a byte that has no code representation due
+ /// to being larger than permitted by the `size` parameter given to the Encoder.
+ InvalidCode,
+}
+
+impl core::fmt::Display for LzwError {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
+ match self {
+ LzwError::InvalidCode => f.write_str("invalid code in LZW stream"),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for LzwError {}