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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
//! Definition of errors returned by this crate
//!
//! This crate uses [`thiserror`] to define its error types.
//!
//! If you encounter an error that you believe is a result of implementation bug
//! rather then user mistake post an issue on Github.
use errno::Errno;
use num_derive::FromPrimitive;
use thiserror::Error;
/// Errors returned by the all functions in the crate.
#[derive(Error, Debug)]
pub enum CodesError {
///Returned when ecCodes library function returns an error code.
///Check [`CodesInternal`] for more details.
#[error("ecCodes function returned a non-zero code {0}")]
Internal(#[from] CodesInternal),
///Returned when one of libc functions returns a non-zero error code.
///Check libc documentation for details of the errors.
///For libc reference check these websites: ([1](https://man7.org/linux/man-pages/index.html))
///([2](https://pubs.opengroup.org/onlinepubs/9699919799/functions/contents.html))
#[error("libc function returned an error with code {0} and errno {1}")]
LibcNonZero(i32, Errno),
///Returned when there is an issue while handlng the file.
///Check the [`std::fs`] documentation why and when this error can occur.
#[error("Error occured while opening the file: {0}")]
FileHandlingInterrupted(#[from] std::io::Error),
///Returned when the string cannot be parsed as valid UTF8 string.
#[error("Cannot parse string as UTF8: {0}")]
CstrUTF8(#[from] std::str::Utf8Error),
///Returned when the C-string returned by ecCodes library cannot be converted
///into a Rust-string.
#[error("String returned by ecCodes is not nul terminated: {0}")]
NulChar(#[from] std::ffi::FromBytesWithNulError),
///Returned when the requested key is not present in the message.
///Similar to [`CodesInternal::CodesNotFound`] and [`CodesInternal::CodesMissingKey`].
#[error("The key is missing in present message")]
MissingKey,
/// Returned when the size of requested key is lower than 1.
/// This indicates corrupted data file, bug in the crate or bug in the ecCodes library.
#[error("Incorrect key size")]
IncorrectKeySize,
/// Returned when codes_handle_clone returns null pointer
/// indicating issues with cloning the message.
#[error("Cannot clone the message")]
CloneFailed,
/// Returned when codes_keys_iterator_new returns null pointer
#[error("Cannot create or manipulate keys iterator")]
KeysIteratorFailed,
/// This error can be returned by almost any function in the crate.
/// It is returned when null pointer was passed to ecCodes function
/// that cannot handle null pointers. This error may indicate both
/// bug in the implementation or incorrect usage of the crate.
#[error("Null pointer encountered where it should not be")]
NullPtr,
/// Returned when function in `message_ndarray` module cannot convert
/// the message to ndarray. Check [`MessageNdarrayError`] for more details.
#[cfg(feature = "message_ndarray")]
#[error("error occured while converting KeyedMessage to ndarray {0}")]
NdarrayConvert(#[from] MessageNdarrayError),
}
/// Errors returned by the `message_ndarray` module.
#[cfg(feature = "message_ndarray")]
#[cfg_attr(docsrs, doc(cfg(feature = "message_ndarray")))]
#[derive(PartialEq, Clone, Error, Debug)]
pub enum MessageNdarrayError {
/// Returned when functions converting to ndarray cannot correctly
/// read key necessary for the conversion.
#[error("Requested key {0} has a different type than expected")]
UnexpectedKeyType(String),
/// Returned when length of values array is not equal to
/// product of Ni and Nj keys.
#[error("The length of the values array ({0}) is different than expected ({1})")]
UnexpectedValuesLength(usize, usize),
/// Returned when functions converting to ndarray cannot correctly
/// parse key necessary for the conversion.
#[error("Requested key {0} has a value out of expected range")]
UnexpectedKeyValue(String),
/// Returned when ndarray cannot create an array with the shape
/// defined by Ni and Nj keys.
#[error("Error occured while converting to ndarray: {0}")]
InvalidShape(#[from] ndarray::ShapeError),
/// This error can occur when casting types of shape fails
/// on 32-bit systems or for very large arrays.
#[error(transparent)]
IntCasting(#[from] std::num::TryFromIntError),
}
///Errors returned by internal ecCodes library functions.
///Copied directly from the ecCodes API.
#[derive(Copy, Eq, PartialEq, Clone, Ord, PartialOrd, Hash, Error, Debug, FromPrimitive)]
pub enum CodesInternal {
///No error
#[error("No error")]
CodesSuccess = 0,
///End of resource reached
#[error("End of resource reached")]
CodesEndOfFile = -1,
///Internal error
#[error("Internal error")]
CodesInternalError = -2,
///Passed buffer is too small
#[error("Passed buffer is too small")]
CodesBufferTooSmall = -3,
///Function not yet implemented
#[error("Function not yet implemented")]
CodesNotImplemented = -4,
///Missing 7777 at end of message
#[error("Missing 7777 at end of message")]
Codes7777NotFound = -5,
///Passed array is too small
#[error("Passed array is too small")]
CodesArrayTooSmall = -6,
///File not found
#[error("File not found")]
CodesFileNotFound = -7,
///Code not found in code table
#[error("Code not found in code table")]
CodesCodeNotFoundInTable = -8,
///Array size mismatch
#[error("Array size mismatch")]
CodesWrongArraySize = -9,
///Key/value not found
#[error("Key/value not found")]
CodesNotFound = -10,
///Input output problem
#[error("Input output problem")]
CodesIoProblem = -11,
///Message invalid
#[error("Message invalid")]
CodesInvalidMessage = -12,
///Decoding invalid
#[error("Decoding invalid")]
CodesDecodingError = -13,
///Encoding invalid
#[error("Encoding invalid")]
CodesEncodingError = -14,
///Code cannot unpack because of string too small
#[error("Code cannot unpack because of string too small")]
CodesNoMoreInSet = -15,
///Problem with calculation of geographic attributes
#[error("Problem with calculation of geographic attributes")]
CodesGeocalculusProblem = -16,
///Memory allocation error
#[error("Memory allocation error")]
CodesOutOfMemory = -17,
///Value is read only
#[error("Value is read only")]
CodesReadOnly = -18,
///Invalid argument
#[error("Invalid argument")]
CodesInvalidArgument = -19,
///Null handle
#[error("Null handle")]
CodesNullHandle = -20,
///Invalid section number
#[error("Invalid section number")]
CodesInvalidSectionNumber = -21,
///Value cannot be missing
#[error("Value cannot be missing")]
CodesValueCannotBeMissing = -22,
///Wrong message length
#[error("Wrong message length")]
CodesWrongLength = -23,
///Invalid key type
#[error("Invalid key type")]
CodesInvalidType = -24,
///Unable to set step
#[error("Unable to set step")]
CodesWrongStep = -25,
///Wrong units for step (step must be integer)
#[error("Wrong units for step (step must be integer)")]
CodesWrongStepUnit = -26,
///Invalid file id
#[error("Invalid file id")]
CodesInvalidFile = -27,
///Invalid grib id
#[error("Invalid grib id")]
CodesInvalidGrib = -28,
///Invalid index id
#[error("Invalid index id")]
CodesInvalidIndex = -29,
///Invalid iterator id
#[error("Invalid iterator id")]
CodesInvalidIterator = -30,
///Invalid keys iterator id
#[error("Invalid keys iterator id")]
CodesInvalidKeysIterator = -31,
///Invalid nearest id
#[error("Invalid nearest id")]
CodesInvalidNearest = -32,
///Invalid order by
#[error("Invalid order by")]
CodesInvalidOrderby = -33,
///Missing a key from the fieldset
#[error("Missing a key from the fieldset")]
CodesMissingKey = -34,
///The point is out of the grid area
#[error("The point is out of the grid area")]
CodesOutOfArea = -35,
///Concept no match
#[error("Concept no match")]
CodesConceptNoMatch = -36,
///Hash array no match
#[error("Hash array no match")]
CodesHashArrayNoMatch = -37,
///Definitions files not found
#[error("Definitions files not found")]
CodesNoDefinitions = -38,
///Wrong type while packing
#[error("Wrong type while packing")]
CodesWrongType = -39,
///End of resource
#[error("End of resource")]
CodesEnd = -40,
///Unable to code a field without values
#[error("Unable to code a field without values")]
CodesNoValues = -41,
///Grid description is wrong or inconsistent
#[error("Grid description is wrong or inconsistent")]
CodesWrongGrid = -42,
///End of index reached
#[error("End of index reached")]
CodesEndOfIndex = -43,
///Null index
#[error("Null index")]
CodesNullIndex = -44,
///End of resource reached when reading message
#[error("End of resource reached when reading message")]
CodesPrematureEndOfFile = -45,
///An internal array is too small
#[error("An internal array is too small")]
CodesInternalArrayTooSmall = -46,
///Message is too large for the current architecture
#[error("Message is too large for the current architecture")]
CodesMessageTooLarge = -47,
///Constant field
#[error("Constant field")]
CodesConstantField = -48,
///Switch unable to find a matching case
#[error("Switch unable to find a matching case")]
CodesSwitchNoMatch = -49,
///Underflow
#[error("Underflow")]
CodesUnderflow = -50,
///Message malformed
#[error("Message malformed")]
CodesMessageMalformed = -51,
///Index is corrupted
#[error("Index is corrupted")]
CodesCorruptedIndex = -52,
///Invalid number of bits per value
#[error("Invalid number of bits per value")]
CodesInvalidBpv = -53,
///Edition of two messages is different
#[error("Edition of two messages is different")]
CodesDifferentEdition = -54,
///Value is different
#[error("Value is different")]
CodesValueDifferent = -55,
///Invalid key value
#[error("Invalid key value")]
CodesInvalidKeyValue = -56,
///String is smaller than requested
#[error("String is smaller than requested")]
CodesStringTooSmall = -57,
///Wrong type conversion
#[error("Wrong type conversion")]
CodesWrongConversion = -58,
///Missing BUFR table entry for descriptor
#[error("Missing BUFR table entry for descriptor")]
CodesMissingBufrEntry = -59,
///Null pointer
#[error("Null pointer")]
CodesNullPointer = -60,
///Attribute is already present = cannot add
#[error("Attribute is already present = cannot add")]
CodesAttributeClash = -61,
///Too many attributes. Increase MAX_ACCESSOR_ATTRIBUTES
#[error("Too many attributes. Increase MAX_ACCESSOR_ATTRIBUTES")]
CodesTooManyAttributes = -62,
///Attribute not found
#[error("Attribute not found")]
CodesAttributeNotFound = -63,
///Edition not supported
#[error("Edition not supported")]
CodesUnsupportedEdition = -64,
///Value out of coding range
#[error("Value out of coding range")]
CodesOutOfRange = -65,
///Size of bitmap is incorrect
#[error("Size of bitmap is incorrect")]
CodesWrongBitmapSize = -66,
///Functionality not enabled
#[error("Functionality not enabled")]
CodesFunctionalityNotEnabled = -67,
}