Struct icu_provider::prelude::DataError

#[non_exhaustive]
pub struct DataError {
    pub kind: DataErrorKind,
    pub key: Option<ResourceKey>,
    pub str_context: Option<&'static str>,
}

The error type for ICU4X data provider operations.

To create one of these, either start with a DataErrorKind or use DataError::custom().

Example

Create a NeedsVariant error and attach a data request for context:

let key: ResourceKey = unimplemented!();
let req: &DataRequest = unimplemented!();
DataErrorKind::NeedsVariant.with_req(key, req);

Create a named custom error:

DataError::custom("This is an example error");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: DataErrorKind

Broad category of the error.

key: Option<ResourceKey>

The data key of the request, if available.

str_context: Option<&'static str>

Additional context, if available.

Implementations

impl DataError

pub const fn custom(str_context: &'static str) -> Self

Returns a new, empty DataError with kind Custom and a string error message.

pub const fn with_key(self, key: ResourceKey) -> Self

Sets the resource key of a DataError, returning a modified error.

pub const fn with_str_context(self, context: &'static str) -> Self

Sets the string context of a DataError, returning a modified error.

pub fn with_type_context<T>(self) -> Self

Sets the string context of a DataError to the given type name, returning a modified error.

pub fn with_req(self, key: ResourceKey, req: &DataRequest) -> Self

Logs the data error with the given request, returning an error containing the resource key.

If the “log_error_context” feature is enabled, this logs the whole request. Either way, it returns an error with the resource key portion of the request as context.

pub fn with_path<P: AsRef<Path> + ?Sized>(self, path: &P) -> Self

Logs the data error with the given context, then return self.

This does not modify the error, but if the “log_error_context” feature is enabled, it will print out the context.

pub fn with_error_context<E: Error + ?Sized>(self, err: &E) -> Self

Logs the data error with the given context, then return self.

This does not modify the error, but if the “log_error_context” feature is enabled, it will print out the context.

pub fn with_display_context<D: Display + ?Sized>(self, context: &D) -> Self

Logs the data error with the given context, then return self.

This does not modify the error, but if the “log_error_context” feature is enabled, it will print out the context.

pub fn with_debug_context<D: Debug + ?Sized>(self, context: &D) -> Self

Logs the data error with the given context, then return self.

This does not modify the error, but if the “log_error_context” feature is enabled, it will print out the context.

Trait Implementations

impl Clone for DataError

fn clone(&self) -> DataError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataError

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

Formats the value using the given formatter.

impl Display for DataError

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

Formats the value using the given formatter.

impl Error for DataError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Error> for DataError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DataError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for DataError

fn from(e: PoisonError<T>) -> Self

Converts to this type from the input type.

impl<M: DataMarker> From<ReturnedPayloadError<M>> for DataError

fn from(other: ReturnedPayloadError<M>) -> Self

Converts to this type from the input type.

impl PartialEq<DataError> for DataError

fn eq(&self, other: &DataError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataError) -> bool

This method tests for !=.

impl Copy for DataError

impl Eq for DataError

impl StructuralEq for DataError

impl StructuralPartialEq for DataError