Enum DocumentError 

#[non_exhaustive]
pub enum DocumentError {
    #[non_exhaustive]
    TypeMismatch {
        message: String,
    },
    #[non_exhaustive]
    NumericCoercionOverflow {
        target: String,
        value: String,
    },
    #[non_exhaustive]
    InvalidInput {
        message: String,
    },
    #[non_exhaustive]
    Custom {
        message: String,
    },
    #[non_exhaustive]
    UnsupportedOperation {
        message: String,
    },
}

Error returned by Document-shaped coercion 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.

#[non_exhaustive]

TypeMismatch

The document’s variant didn’t match the type the caller asked for, and no coercion is defined between the actual and the requested type.

Example: calling DiscriminatedDocument::as_blob on a Document::Number(_).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

Description of what was expected vs. what was found.

#[non_exhaustive]

NumericCoercionOverflow

A numeric coercion overflowed the target type’s representable range.

Emitted when a source value is outside the target’s [min, max] range.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

target: String

Target type name (e.g. "byte", "integer", "long").

value: String

String representation of the overflowing value, included for diagnostics.

#[non_exhaustive]

InvalidInput

The document’s value couldn’t be parsed into the requested representation. Distinct from TypeMismatch: the variants match, but the underlying string is malformed.

Example: a Document::String whose text isn’t valid base64 when coercing to a blob.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

Description of the problem.

#[non_exhaustive]

Custom

Catch-all for errors not covered by other variants.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

Explanatory message.

#[non_exhaustive]

UnsupportedOperation

The operation is not supported on this document. Used by DiscriminatedDocument’s format-aware coercion accessors, and by DocumentSettings trait default methods for a coercion a particular protocol doesn’t support.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message: String

Description of which operation isn’t supported and why.

Implementations

impl DocumentError

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

Creates a TypeMismatch error with the given message describing what was expected versus what was found.

pub fn numeric_coercion_overflow( target: impl Into<String>, value: impl Into<String>, ) -> Self

Creates a NumericCoercionOverflow error for a value that is outside the representable range of target (e.g. "byte").

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

Creates an InvalidInput error with the given message.

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

Creates a custom error with the given message.

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

Creates an UnsupportedOperation error with the given message.

Trait Implementations

impl Debug for DocumentError

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

Formats the value using the given formatter.

impl Display for DocumentError

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

Formats the value using the given formatter.

impl Error for DocumentError

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.