Struct SetError 

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

A per-item error in a /set response (notCreated, notUpdated, notDestroyed maps) (RFC 8620 §5.3).

Construct with SetError::new and chain the builder methods as needed.

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

The machine-readable error type.

description: Option<String>

Optional human-readable description of the error.

properties: Option<Vec<String>>

Property names that caused the error (for invalidProperties).

existing_id: Option<Id>

The existing object id (for alreadyExists — RFC 8621 §5.7).

max_recipients: Option<u64>

Maximum recipients allowed (for tooManyRecipients — RFC 8621 §7.5).

invalid_recipients: Option<Vec<String>>

Invalid recipient addresses (for invalidRecipients — RFC 8621 §7.5).

not_found: Option<Vec<Id>>

Missing blob IDs (for blobNotFound — RFC 8621 §5.5).

max_size: Option<u64>

Maximum message size in octets (for tooLarge on EmailSubmission — RFC 8621 §7.5).

extra: Map<String, Value>

Catch-all for extension-defined SetError fields not covered by the typed members above.

JMAP extensions sometimes ship error variants whose wire shape includes additional structured fields beyond the RFC 8620 §5.3 base set — e.g. JMAP Chat’s rateLimited SetError carries a serverRetryAfter UTCDate telling the client when it may retry, and mdnAlreadySent (RFC 8621 §7.7) is a typed extension error variant. This map preserves any such field across serialize / deserialize round-trip, mirroring the extras-preservation policy on the client-side jmap_types::SetError type.

Use SetError::with_extra to populate from handler code:

SetError::new(SetErrorType::custom("rateLimited"))
    .with_description("Slow mode is active for this chat")
    .with_extra("serverRetryAfter", json!(retry_after_str))

Per workspace AGENTS.md “Extras-preservation policy” — wire format is byte-identical to a pre-extras SetError when the map is empty (the skip_serializing_if collapses it).

Implementations

impl SetError

pub fn new(error_type: SetErrorType) -> Self

Construct a SetError with the given type and all optional fields None.

pub fn with_description(self, desc: impl Into<String>) -> Self

Set the human-readable description.

pub fn with_properties<I, S>(self, props: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the list of property names that caused the error.

pub fn with_existing_id(self, id: Id) -> Self

Set the existing object id (used with alreadyExists).

pub fn with_max_recipients(self, n: u64) -> Self

Set the maximum recipients (used with tooManyRecipients — RFC 8621 §7.5).

pub fn with_invalid_recipients<I, S>(self, addrs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the invalid recipient addresses (used with invalidRecipients — RFC 8621 §7.5).

pub fn with_not_found(self, ids: Vec<Id>) -> Self

Set the missing blob IDs (used with blobNotFound — RFC 8621 §5.5).

pub fn with_max_size(self, n: u64) -> Self

Set the maximum message size in octets (used with tooLarge on EmailSubmission — RFC 8621 §7.5).

pub fn with_extra(self, key: &str, value: Value) -> Self

Insert an extension-defined field into Self::extra.

Used by handlers to attach typed wire fields that no with_* builder covers — for example JMAP Chat’s rateLimited SetError must carry a serverRetryAfter UTCDate:

SetError::new(SetErrorType::custom("rateLimited"))
    .with_description("Slow mode is active for this chat")
    .with_extra("serverRetryAfter", serde_json::json!(retry_after_str))

The serialized wire shape merges key/value at the same level as the typed fields (via #[serde(flatten)] on Self::extra). Calling with_extra("type", ...), with_extra("properties", ...), or any other reserved wire-name will produce a malformed SetError on the wire — callers are responsible for choosing extension-namespace keys that do not collide with the typed-field wire names.

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<E> From<SetError> for BackendSetError<E>

fn from(e: SetError) -> Self

Converts to this type from the input type.

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