Struct Error

pub struct Error { /* private fields */ }

An error that can occur in this crate.

The most common type of error is a result of overflow. But other errors exist as well:

• Time zone database lookup failure.
• Configuration problem. (For example, trying to round a span with calendar units without providing a relative datetime.)
• An I/O error as a result of trying to open a time zone database from a directory via TimeZoneDatabase::from_dir.
• Parse errors.

Introspection is limited

Other than implementing the std::error::Error trait when the std feature is enabled, the core::fmt::Debug trait and the core::fmt::Display trait, this error type currently provides no introspection capabilities.

Design

This crate follows the “One True God Error Type Pattern,” where only one error type exists for a variety of different operations. This design was chosen after attempting to provide finer grained error types. But finer grained error types proved difficult in the face of composition.

More about this design choice can be found in a GitHub issue about error types.

Implementations

impl Error

pub fn from_args<'a>(message: Arguments<'a>) -> Error

Creates a new error value from core::fmt::Arguments.

It is expected to use format_args! from Rust’s standard library (available in core) to create a core::fmt::Arguments.

Callers should generally use their own error types. But in some circumstances, it can be convenient to manufacture a Jiff error value specifically.

Example

use jiff::Error;

let err = Error::from_args(format_args!("something failed"));
assert_eq!(err.to_string(), "something failed");

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Error

Converts to this type from the input type.