Struct JmapError 

#[non_exhaustive]
pub struct JmapError {
    pub error_type: MethodErrorType,
    pub description: Option<String>,
    pub limit: Option<u64>,
    pub limit_name: Option<String>,
}

JMAP method-level error, serializable for inclusion in methodResponses.

See RFC 8620 §3.6.2 for the standard error types. The JSON key is "type" (not "error_type") per RFC 8620.

Fields (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.

error_type: MethodErrorType

Error type per RFC 8620 §3.6.

description: Option<String>

Human-readable description. Omitted from JSON when None.

limit: Option<u64>

Maximum maxChanges value the server will accept. Only set for "tooManyChanges" (RFC 8620 §9.6.1 MUST).

limit_name: Option<String>

Name of the exceeded limit for a request-level limit error (RFC 8620 §3.6.1: “the “limit” property MUST contain the name of the limit being applied“), e.g. "maxCallsInRequest".

Request-level errors are sent as an RFC 7807 problem-details body, where jmap-server writes this as the "limit" property. It never appears in a methodResponses error, so it is not serialized here (the limit key there is the tooManyChanges count).

Implementations

impl JmapError

pub fn invalid_arguments(desc: impl Into<String>) -> Self

RFC 8620 §3.6.2 — “invalidArguments”

pub fn forbidden() -> Self

RFC 8620 §3.6.2 — “forbidden”

pub fn account_not_found() -> Self

RFC 8620 §5.1 — “accountNotFound”

pub fn account_not_supported_by_method() -> Self

RFC 8620 §5.1 — “accountNotSupportedByMethod”

pub fn account_read_only() -> Self

RFC 8620 §5.1 — “accountReadOnly”

pub fn server_unavailable() -> Self

RFC 8620 §3.6.2 — “serverUnavailable”

pub fn server_fail(desc: impl Into<String>) -> Self

RFC 8620 §3.6.2 — “serverFail”

pub fn server_partial_fail() -> Self

RFC 8620 §3.6.2 — “serverPartialFail”

pub fn unknown_method() -> Self

RFC 8620 §3.6.2 — “unknownMethod”

pub fn invalid_result_reference() -> Self

RFC 8620 §3.6.2 — “invalidResultReference”

pub fn cannot_calculate_changes() -> Self

RFC 8620 §5.2 and §5.6 — “cannotCalculateChanges”

pub fn state_mismatch() -> Self

RFC 8620 §5.3 — “stateMismatch”

pub fn too_large() -> Self

“tooLarge” — a method-level error of Principal/getAvailability (draft-ietf-jmap-calendars §2.2); RFC 8620 §5.3 defines it only as a SetError.

pub fn request_too_large() -> Self

RFC 8620 §5.1 and §5.3 — “requestTooLarge”

pub fn rate_limit() -> Self

“rateLimit” — a method-level error of Principal/getAvailability (draft-ietf-jmap-calendars §2.2); RFC 8620 §5.3 defines it only as a SetError.

pub fn unsupported_filter() -> Self

RFC 8620 §5.5 — “unsupportedFilter”

pub fn anchor_not_found() -> Self

RFC 8620 §5.5 — “anchorNotFound”

pub fn from_account_not_found() -> Self

RFC 8620 §5.4 — “fromAccountNotFound”

pub fn from_account_not_supported_by_method() -> Self

RFC 8620 §5.4 — “fromAccountNotSupportedByMethod”

pub fn unsupported_sort() -> Self

RFC 8620 §5.5 — “unsupportedSort”

pub fn too_many_changes_with_limit(limit: u64) -> Self

Returns a tooManyChanges error with the server’s limit included.

Per RFC 8620 §9.6.1, the limit field MUST be present so the client knows the maximum maxChanges value to use on retry.

pub fn not_json() -> Self

RFC 8620 §3.6.1 — “notJSON” (request-level error)

The request body was not valid JSON or did not have application/json content type.

pub fn not_request() -> Self

RFC 8620 §3.6.1 — “notRequest” (request-level error)

The request parsed as JSON but did not match the JMAP Request object shape.

pub fn limit(limit_name: impl Into<String>) -> Self

RFC 8620 §3.6.1 — “limit” (request-level error)

The request was rejected because it would exceed a capability limit such as maxCallsInRequest or maxSizeRequest.

limit_name is the name of the exceeded limit (e.g. "maxCallsInRequest"), stored in limit_name. The HTTP layer (jmap-server::RequestError) writes it as the RFC-required "limit" property of the RFC 7807 problem-details body.

pub fn unknown_capability_with_detail(uri: impl Into<String>) -> Self

“unknownCapability” with the failing URI surfaced to the client.

The URI is stored in description. The HTTP layer (jmap-server::RequestError) reads description to populate the "detail" field in the RFC 7807 problem-details response body — the same mechanism used by limit() for its limit-name payload.

Invariant: always construct unknownCapability errors that carry a URI with this function, never by setting description manually. A missing or incorrect description means the client never learns which capability it requested that the server does not support.

pub fn custom(error_type: impl Into<MethodErrorType>) -> Self

Create a JmapError with an extension error type such as "rateLimited".

A string naming a known type builds that variant (JmapError::custom("forbidden") equals JmapError::forbidden).

Trait Implementations

impl Clone for JmapError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JmapError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JmapError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JmapError

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

Formats the value using the given formatter.

impl Eq for JmapError

impl Error for JmapError

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 PartialEq for JmapError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JmapError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JmapError