Struct ProtonApiError 

pub struct ProtonApiError {
    pub code: ResponseCode,
    pub http_status: u16,
    pub message: String,
    pub details: Option<Value>,
}

An error reported by the Proton API in its response envelope.

Fields

code: ResponseCode

Application-level response code from the Code field.

http_status: u16

HTTP status code of the response.

message: String

Human-readable message from the Error field, if present.

details: Option<Value>

Raw Details object from the error envelope, when present. Endpoint specific — e.g. a revision-creation conflict names the existing draft.

Implementations

impl ProtonApiError

pub fn is_unauthorized(&self) -> bool

pub fn is_invalid_refresh_token(&self) -> bool

pub fn is_insufficient_scope(&self) -> bool

The token lacks a scope the endpoint requires — no amount of refreshing fixes it; the user must authenticate with their password again.

pub fn is_human_verification_required(&self) -> bool

The request was gated behind human verification.

pub fn human_verification(&self) -> Option<HumanVerification>

The human-verification challenge, when this error carries one.

None if the code is something else, or if the server gated the request without describing how to satisfy it — which is not recoverable in-app and should surface as a plain failure rather than an empty webview.

Trait Implementations

impl Clone for ProtonApiError

fn clone(&self) -> ProtonApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtonApiError

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

Formats the value using the given formatter.

impl Display for ProtonApiError

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

Formats the value using the given formatter.

impl Error for ProtonApiError

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<ProtonApiError> for ProtonError

fn from(source: ProtonApiError) -> Self

Converts to this type from the input type.