#[non_exhaustive]pub enum Error {
UnknownFormat {
path: PathBuf,
},
Unsupported {
format: &'static str,
feature: String,
hint: Option<String>,
},
Corrupt {
format: &'static str,
detail: String,
offset: Option<u64>,
},
Usage(String),
Io {
path: PathBuf,
source: Error,
},
Other(String),
}Expand description
Every failure OpenReadout can report. Each variant maps to a stable string code
(for JSON) and an exit code (for shells).
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
UnknownFormat
The file does not match any supported format’s signature.
Unsupported
The format is known but this file uses a feature we do not decode yet.
Fields
Corrupt
The file violates its own format’s invariants (truncation, bad offsets, …).
Fields
Usage(String)
Bad arguments or an impossible request (e.g. plane index out of range).
Io
Operating-system I/O failure.
Other(String)
Anything else.
Implementations§
Source§impl Error
impl Error
Sourcepub fn io(path: impl Into<PathBuf>, source: Error) -> Self
pub fn io(path: impl Into<PathBuf>, source: Error) -> Self
Convenience constructor for I/O errors carrying the path.
Sourcepub fn corrupt(format: &'static str, detail: impl Into<String>) -> Self
pub fn corrupt(format: &'static str, detail: impl Into<String>) -> Self
Convenience constructor for corruption findings.
Trait Implementations§
Source§impl Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0:
use the Display impl or to_string()
Auto Trait Implementations§
impl !RefUnwindSafe for Error
impl !UnwindSafe for Error
impl Freeze for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl UnsafeUnpin for Error
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more