#[non_exhaustive]pub enum Error {
UnexpectedEof {
what: &'static str,
},
UnexpectedByte {
byte: u8,
offset: usize,
what: &'static str,
},
InvalidNumber {
text: String,
},
Malformed {
what: &'static str,
offset: Option<usize>,
},
Io {
message: String,
},
Unsupported {
what: &'static str,
},
Limit {
what: &'static str,
limit: usize,
},
TooMany {
what: &'static str,
limit: usize,
},
}Expand description
Every failure mode the crate reports.
The set grows as new layers (cross-reference tables, filters, content
streams, encryption) are added, which is why it is #[non_exhaustive]:
matching on it from outside the crate needs a catch-all arm.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
UnexpectedEof
The input ended in the middle of a construct.
what names the construct being read, for example "number".
UnexpectedByte
A byte that cannot start the expected construct was found.
offset is the position of byte within the input being read.
Fields
InvalidNumber
A numeric token could not be parsed.
Malformed
The input is structurally wrong in a way particular to what.
offset is where the problem was noticed, if it is known.
Fields
Io
Reading or writing a file failed.
Unsupported
A construct this version does not implement yet.
Unlike Error::Malformed, the file is not wrong: the reader simply
does not support the feature, and callers may choose to skip it.
The variant is last on purpose: inserting one earlier would shift the
implicit discriminants of every variant after it, which cargo semver-checks rightly treats as a breaking change for a public enum.
Limit
A decoded stream grew past the document’s decoded-bytes budget.
what names the stage that hit it ("a Flate stream", "the unfiltered stream") and limit is the budget in bytes. Added last on
purpose: a variant in the middle shifts the discriminants of the ones
after it, which cargo-semver-checks reports as a breaking change.
Fields
TooMany
A document declared or produced more of something than its budget allows.
what names the counted thing ("objects", "pages") and limit is
the ceiling; both are settable on crate::Document. Added last for the
same reason Error::Limit was.
Implementations§
Trait Implementations§
impl Eq for Error
Source§impl Error for Error
impl Error for Error
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()