Enum rust_icu_common::Error

pub enum Error {
    Sys(UErrorCode),
    Wrapper(Error),
}

Represents a Unicode error, resulting from operations of low-level ICU libraries.

This is modeled after absl::Status in the Abseil library, which provides ways for users to avoid dealing with all the numerous error codes directly.

Variants

Sys(UErrorCode)

The error originating in the underlying sys library.

At the moment it is possible to produce an Error which has a zero error code (i.e. no error), because it makes it unnecessary for users to deal with error codes directly. It does make for a bit weird API, so we may turn it around a bit. Ideally, it should not be possible to have an Error that isn’t really an error.

Wrapper(Error)

Errors originating from the wrapper code. For example when pre-converting input into UTF8 for input that happens to be malformed.

Implementations

impl Error

pub const OK_CODE: UErrorCode = sys::UErrorCode::U_ZERO_ERROR

The error code denoting no error has happened.

pub fn is_ok(code: UErrorCode) -> bool

Returns true if this error code corresponds to no error.

pub fn ok_or_warning(status: UErrorCode) -> Result<(), Self>

Creates a new error from the supplied status. Ok is returned if the error code does not correspond to an error code (as opposed to OK or a warning code).

pub fn ok_preflight(status: UErrorCode) -> Result<(), Self>

Creates a new error from the supplied status. Ok is returned if the error code does not constitute an error in preflight mode.

This error check explicitly ignores the buffer overflow error when reporting whether it contains an error condition.

Preflight calls to ICU libraries do a read-only scan of the input to determine the buffer sizes required on the output in case of conversion calls such as ucal_strFromUTF8. The way this call is made is to offer a zero-capacity buffer (which could be pointed to by a NULL pointer), and then call the respective function. The function will compute the buffer size, but will also return a bogus buffer overflow error.

pub fn is_code(&self, code: UErrorCode) -> bool

Returns true if this error has the supplied code.

pub fn is_err(&self) -> bool

Returns true if the error is an error, not a warning.

The ICU4C library has error codes for errors and warnings.

pub fn is_preflight_err(&self) -> bool

Return true if there was an error in a preflight call.

This error check explicitly ignores the buffer overflow error when reporting whether it contains an error condition.

Preflight calls to ICU libraries do a read-only scan of the input to determine the buffer sizes required on the output in case of conversion calls such as ucal_strFromUTF8. The way this call is made is to offer a zero-capacity buffer (which could be pointed to by a NULL pointer), and then call the respective function. The function will compute the buffer size, but will also return a bogus buffer overflow error.

pub fn is_warn(&self) -> bool

Returns true if the error is, in fact, a warning (nonfatal).

pub fn wrapper(source: impl Into<Error>) -> Self

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(e: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<NulError> for Error

fn from(e: NulError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(e: Utf8Error) -> Self

Converts to this type from the input type.

impl Into<Error> for Error

fn into(self) -> Error

Converts this type into the (usually inferred) input type.