1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
use core::fmt::Debug;
pub use embedded_io::blocking::ReadExactError;
pub use embedded_io::Error as IoError;
pub use embedded_io::ErrorKind;
pub use embedded_io::Io as IoBase;
use crate::io::StdErrWrapper;
/// Error enum with all errors that can be returned by functions from this crate
///
/// Generic parameter `T` is a type of external error returned by the user provided storage
#[derive(Debug)]
#[non_exhaustive]
pub enum Error<T> {
/// A user provided storage instance returned an error during an input/output operation.
Io(T),
/// A read operation cannot be completed because an end of a file has been reached prematurely.
UnexpectedEof,
/// A write operation cannot be completed because `Write::write` returned 0.
WriteZero,
/// A parameter was incorrect.
InvalidInput,
/// A requested file or directory has not been found.
NotFound,
/// A file or a directory with the same name already exists.
AlreadyExists,
/// An operation cannot be finished because a directory is not empty.
DirectoryIsNotEmpty,
/// File system internal structures are corrupted/invalid.
CorruptedFileSystem,
/// There is not enough free space on the storage to finish the requested operation.
NotEnoughSpace,
/// The provided file name is either too long or empty.
InvalidFileNameLength,
/// The provided file name contains an invalid character.
UnsupportedFileNameCharacter,
}
impl<T: Debug> IoError for Error<T> {
fn kind(&self) -> ErrorKind {
ErrorKind::Other
}
}
impl<T: IoError> From<T> for Error<T> {
fn from(error: T) -> Self {
Error::Io(error)
}
}
impl<T> From<ReadExactError<Error<T>>> for Error<T> {
fn from(error: ReadExactError<Error<T>>) -> Self {
match error {
ReadExactError::UnexpectedEof => Self::UnexpectedEof,
ReadExactError::Other(error) => error,
}
}
}
impl<T: IoError> From<ReadExactError<T>> for Error<T> {
fn from(error: ReadExactError<T>) -> Self {
match error {
ReadExactError::UnexpectedEof => Self::UnexpectedEof,
ReadExactError::Other(error) => error.into(),
}
}
}
#[cfg(feature = "std")]
impl From<Error<StdErrWrapper>> for std::io::Error {
fn from(error: Error<StdErrWrapper>) -> Self {
match error {
Error::Io(io_error) => io_error.into(),
Error::UnexpectedEof | Error::NotEnoughSpace => {
Self::new(std::io::ErrorKind::UnexpectedEof, error)
}
Error::WriteZero => Self::new(std::io::ErrorKind::WriteZero, error),
Error::InvalidInput
| Error::InvalidFileNameLength
| Error::UnsupportedFileNameCharacter
| Error::DirectoryIsNotEmpty => Self::new(std::io::ErrorKind::InvalidInput, error),
Error::NotFound => Self::new(std::io::ErrorKind::NotFound, error),
Error::AlreadyExists => Self::new(std::io::ErrorKind::AlreadyExists, error),
Error::CorruptedFileSystem => Self::new(std::io::ErrorKind::InvalidData, error),
}
}
}
impl<T: core::fmt::Display> core::fmt::Display for Error<T> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
match self {
Error::Io(io_error) => write!(f, "IO error: {}", io_error),
Error::UnexpectedEof => write!(f, "Unexpected end of file"),
Error::NotEnoughSpace => write!(f, "Not enough space"),
Error::WriteZero => write!(f, "Write zero"),
Error::InvalidInput => write!(f, "Invalid input"),
Error::InvalidFileNameLength => write!(f, "Invalid file name length"),
Error::UnsupportedFileNameCharacter => write!(f, "Unsupported file name character"),
Error::DirectoryIsNotEmpty => write!(f, "Directory is not empty"),
Error::NotFound => write!(f, "No such file or directory"),
Error::AlreadyExists => write!(f, "File or directory already exists"),
Error::CorruptedFileSystem => write!(f, "Corrupted file system"),
}
}
}
#[cfg(feature = "std")]
impl<T: std::error::Error + 'static> std::error::Error for Error<T> {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
if let Error::Io(io_error) = self {
Some(io_error)
} else {
None
}
}
}
#[cfg(feature = "std")]
impl core::fmt::Display for StdErrWrapper {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "pls implement")
}
}
#[cfg(feature = "std")]
impl std::error::Error for StdErrWrapper {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
// /// Trait that should be implemented by errors returned from the user supplied storage.
// ///
// /// Implementations for `std::io::Error` and `()` are provided by this crate.
// pub trait IoError: core::fmt::Debug {
// fn is_interrupted(&self) -> bool;
// fn new_unexpected_eof_error() -> Self;
// fn new_write_zero_error() -> Self;
// }
//
// impl<T: core::fmt::Debug + IoError> IoError for Error<T> {
// fn is_interrupted(&self) -> bool {
// match self {
// Error::<T>::Io(io_error) => io_error.is_interrupted(),
// _ => false,
// }
// }
//
// fn new_unexpected_eof_error() -> Self {
// Error::<T>::UnexpectedEof
// }
//
// fn new_write_zero_error() -> Self {
// Error::<T>::WriteZero
// }
// }
//
// impl IoError for () {
// fn is_interrupted(&self) -> bool {
// false
// }
//
// fn new_unexpected_eof_error() -> Self {
// // empty
// }
//
// fn new_write_zero_error() -> Self {
// // empty
// }
// }
//
// #[cfg(feature = "std")]
// impl IoError for std::io::Error {
// fn is_interrupted(&self) -> bool {
// self.kind() == std::io::ErrorKind::Interrupted
// }
//
// fn new_unexpected_eof_error() -> Self {
// Self::new(std::io::ErrorKind::UnexpectedEof, "failed to fill whole buffer")
// }
//
// fn new_write_zero_error() -> Self {
// Self::new(std::io::ErrorKind::WriteZero, "failed to write whole buffer")
// }
// }