Struct DittoError 

pub struct DittoError { /* private fields */ }

Custom error for Ditto.

Recoverable errors

Use its .kind() method to be able to match on a bunch of specific known ErrorKinds.

• ⚠️ be aware that the list of possible kinds is not exhaustive.

Unexpected/unrecoverable errors

Can be {}-Displayed for a human-friendly message and representation.

Implementations

impl DittoError

pub fn kind(&self) -> ErrorKind

Return the kind of the Error

pub fn encryption_error_kind(&self) -> Option<CoreApiErrorKind>

If this error originated from the store’s encryption layer, returns the specific CoreApiErrorKind describing it; otherwise None.

This groups the encryption-related CoreApiErrorKind variants so that callers can react to encryption problems without matching each variant individually. The variants covered are:

• CoreApiErrorKind::EncryptionKeyRequired
• CoreApiErrorKind::EncryptionKeyUnexpected
• CoreApiErrorKind::EncryptionKeyInvalid
• CoreApiErrorKind::EncryptionUnsupportedScheme
• CoreApiErrorKind::EncryptionMetadataCorrupt

An encrypted store whose contents are corrupt fails key validation the same way, so severe corruption of an encrypted store can also surface as CoreApiErrorKind::EncryptionKeyInvalid.

pub fn is_encryption_error(&self) -> bool

Returns true if this error originated from the store’s encryption layer (a missing, unexpected, or invalid encryption key, an unsupported on-disk encryption scheme, or corrupt encryption metadata).

See Self::encryption_error_kind() to recover the specific kind.

pub fn get_authentication_client_feedback( &self, ) -> Option<AuthenticationClientFeedback>

If this is an Authentication error, get feedback from the auth provider.

The returned value may contain arbitrary JSON from the auth service with details describing the success or rejection of the authentication request.

Trait Implementations

impl Debug for DittoError

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

Formats the value using the given formatter.

impl Display for DittoError

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

Formats the value using the given formatter.

impl Error for DittoError

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<Box<FfiError>> for DittoError

fn from(raw: Box<FfiError>) -> Self

Converts to this type from the input type.

impl From<Error> for DittoError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DittoError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DittoError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for DittoError

fn from(kind: ErrorKind) -> DittoError

Converts to this type from the input type.

impl From<Infallible> for DittoError

fn from(err: Infallible) -> Self

Converts to this type from the input type.

impl From<JoinError> for DittoError

fn from(err: JoinError) -> Self

Converts to this type from the input type.

impl From<NonZero<i32>> for DittoError

fn from(code: NonZeroI32) -> Self

Converts to this type from the input type.

impl From<i32> for DittoError

fn from(code: i32) -> Self

Converts to this type from the input type.