Struct WsRequestError 

#[non_exhaustive]
pub struct WsRequestError {
    pub request_id: Option<String>,
    pub problem_type: String,
    pub status: Option<u16>,
    pub detail: Option<String>,
    pub limit: Option<String>,
    pub extra: Map<String, Value>,
}

A request-level error received over WebSocket (RFC 8887 §4.3.4).

An RFC 8620 §3.6.1 Problem Details object extended with "@type": "RequestError" and requestId. The server sends one instead of a Response when the whole request is rejected (not JSON, unknown capability, limit exceeded, …).

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.

request_id: Option<String>

requestId: the id of the request this error answers. None when the server sent null or omitted it.

problem_type: String

Problem Details type URI, e.g. "urn:ietf:params:jmap:error:notJSON" (RFC 8620 §3.6.1).

status: Option<u16>

Problem Details status: the HTTP status code the error would carry over HTTP.

detail: Option<String>

Problem Details detail: human-readable explanation.

limit: Option<String>

limit: the name of the exceeded limit, present for urn:ietf:params:jmap:error:limit (RFC 8620 §3.6.1).

extra: Map<String, Value>

Remaining fields (@type, title, vendor extensions), preserved per the workspace extras-preservation policy.

Trait Implementations

impl Clone for WsRequestError

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 WsRequestError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsRequestError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WsRequestError

impl PartialEq for WsRequestError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WsRequestError

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 WsRequestError