Struct DataError

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

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 NeedsLocale error and attach a data request for context:

let key: DataKey = unimplemented!();
let req: DataRequest = unimplemented!();
DataErrorKind::NeedsLocale.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<DataKey>

The data key of the request, if available.

str_context: Option<&'static str>

Additional context, if available.

silent: bool

Whether this error was created in silent mode to not log.

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: DataKey) -> 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: DataKey, req: DataRequest<'_>) -> Self

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

If the “logging” Cargo 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_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 “logging” Cargo 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 “logging” Cargo 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 PartialEq for DataError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DataError

impl Eq for DataError

impl StructuralPartialEq for DataError