Struct icu_provider::DataError

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

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)§

This struct is marked as 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§

source§

impl DataError

source

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

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

source

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

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

source

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

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

source

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

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

source

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.

source

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.

source

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.

source

pub(crate) fn for_type<T>() -> DataError

Trait Implementations§

source§

impl Clone for DataError

source§

fn clone(&self) -> DataError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DataError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for DataError

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for DataError

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for DataError

source§

impl Eq for DataError

source§

impl StructuralPartialEq for DataError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T