Enum MaxMindDbError 

#[non_exhaustive]
pub enum MaxMindDbError {
    InvalidDatabase {
        message: String,
        offset: Option<usize>,
    },
    Io(Error),
    Mmap(Error),
    Decoding {
        message: String,
        offset: Option<usize>,
        path: Option<String>,
    },
    ResourceLimit {
        message: String,
        offset: Option<usize>,
        path: Option<String>,
    },
    InvalidNetwork(IpNetworkError),
    InvalidInput {
        message: String,
    },
}

Error returned by MaxMind DB operations.

Variants (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.

InvalidDatabase

The database file is invalid or corrupted.

Fields

message: String

Description of what is invalid.

offset: Option<usize>

Byte offset where the error was detected. Reader operations report an absolute database-file offset; decoding a standalone section reports an offset relative to that input.

Io(Error)

An I/O error occurred while reading the database.

Mmap(Error)

Memory mapping failed.

Decoding

Error decoding data from the database.

Fields

message: String

Description of the decoding error.

offset: Option<usize>

Byte offset relative to the section being decoded: the data section for records, or the metadata value after its marker for metadata.

path: Option<String>

JSON-pointer-like path to the field (e.g., “/city/names/en”).

ResourceLimit

Decoding or verification stopped because it exceeded an expansion or work safety limit.

This does not necessarily mean that the database is structurally invalid. Schema-specific limits reported by a custom Serde visitor use MaxMindDbError::Decoding instead. Applications may choose a narrower schema or reject the database as untrusted input.

Fields

message: String

Description of the limit that was exceeded.

offset: Option<usize>

Byte offset relative to the section being decoded: the data section for records, or the metadata value after its marker for metadata.

path: Option<String>

JSON-pointer-like path to the field (e.g., “/subdivisions”).

InvalidNetwork(IpNetworkError)

The provided network/CIDR is invalid.

InvalidInput

The provided input is invalid for this operation.

Fields

message: String

Description of what is invalid about the input.

Implementations

impl MaxMindDbError

pub fn invalid_database(message: impl Into<String>) -> Self

Creates an InvalidDatabase error with just a message.

pub fn invalid_database_at(message: impl Into<String>, offset: usize) -> Self

Creates an InvalidDatabase error with message and offset.

pub fn decoding(message: impl Into<String>) -> Self

Creates a Decoding error with just a message.

pub fn decoding_at(message: impl Into<String>, offset: usize) -> Self

Creates a Decoding error with message and offset.

pub fn decoding_at_path( message: impl Into<String>, offset: usize, path: impl Into<String>, ) -> Self

Creates a Decoding error with message, offset, and path.

pub fn resource_limit_at(message: impl Into<String>, offset: usize) -> Self

Creates a ResourceLimit error with a message and offset.

pub fn invalid_input(message: impl Into<String>) -> Self

Creates an InvalidInput error.

Trait Implementations

impl Debug for MaxMindDbError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for MaxMindDbError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for MaxMindDbError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Error for MaxMindDbError

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl Error for Box<MaxMindDbError>

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl From<Box<MaxMindDbError>> for MaxMindDbError

fn from(error: Box<MaxMindDbError>) -> Self

Converts to this type from the input type.

impl From<Error> for MaxMindDbError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<IpNetworkError> for MaxMindDbError

fn from(source: IpNetworkError) -> Self

Converts to this type from the input type.