Struct SetError 

#[non_exhaustive]
pub struct SetError {
    pub error_type: String,
    pub description: Option<String>,
    pub properties: Option<Vec<String>>,
    pub existing_id: Option<Id>,
    pub not_found: Option<Vec<Id>>,
    pub max_recipients: Option<u64>,
    pub invalid_recipients: Option<Vec<String>>,
    pub max_size: Option<u64>,
    pub extra: Map<String, Value>,
}

A per-item failure in a /set response (RFC 8620 §5.3).

Appears as the value type in the notCreated, notUpdated, and notDestroyed maps of SetResponse. The error_type field uses String rather than a typed enum so extension errors (e.g. "calendarHasEvent", "noSupportedScheduleMethods") round-trip cleanly without requiring a version-bump on every new spec extension.

All fields beyond error_type are optional and present only when the corresponding error type calls for them per RFC 8620 §5.3 / RFC 8621 §5.5, §5.7, §7.5:

Field	Set when error_type is	Spec
description	any (optional human-readable detail)	RFC 8620 §5.3
properties	invalidProperties	RFC 8620 §5.3
existing_id	alreadyExists	RFC 8620 §5.4, RFC 8621 §5.7
not_found	blobNotFound	RFC 8621 §5.5
max_recipients	tooManyRecipients	RFC 8621 §7.5
invalid_recipients	invalidRecipients	RFC 8621 §7.5
max_size	tooLarge	RFC 8621 §7.5

Extension fields

JMAP extensions (e.g. JMAP Chat’s serverRetryAfter for slow-mode rate limiting) MAY add additional SetError fields beyond the RFC 8620 base set. The extra field captures any such field via #[serde(flatten)] so it round-trips losslessly. Extension crates (e.g. jmap-chat-client) provide typed accessor helpers that read from extra — the base type stays free of extension-specific fields.

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: String

The machine-readable error type (e.g. "forbidden", "notFound", "alreadyExists", or an extension-defined string).

description: Option<String>

Human-readable description of the error. Optional per RFC 8620 §5.3.

properties: Option<Vec<String>>

Property names that caused the error (for invalidProperties).

existing_id: Option<Id>

The existing object id (for alreadyExists).

not_found: Option<Vec<Id>>

Missing blob ids (for blobNotFound).

max_recipients: Option<u64>

Maximum recipients allowed (for tooManyRecipients).

invalid_recipients: Option<Vec<String>>

Invalid recipient addresses (for invalidRecipients).

max_size: Option<u64>

Maximum message size in octets (for tooLarge).

extra: Map<String, Value>

Catch-all for extension SetError fields not in the RFC 8620 base set. Captured via #[serde(flatten)] so they round-trip losslessly. Extension crates provide typed accessors (e.g. jmap-chat-client’s helper for reading serverRetryAfter).

Uses serde_json::Map (which preserves insertion order) rather than HashMap to match the workspace extras-preservation policy (see workspace AGENTS.md) and to give callers deterministic serialized output.

Implementations

impl SetError

pub fn new(error_type: impl Into<String>) -> Self

Construct a SetError with the given type string and all optional fields None / empty. Use this when deserializing tests or when constructing a wire-shaped error from a typed source. Server crates that want a typed enum for construction should use jmap_server::backend::SetError (declared in the jmap-server crate, not linkable from here since jmap-types does not depend on jmap-server) — this type is deliberately String-typed for client-side parsing flexibility.

Trait Implementations

impl Clone for SetError

fn clone(&self) -> SetError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SetError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SetError

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

Formats the value using the given formatter.

impl PartialEq for SetError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SetError

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 SetError