Struct StateChange 

#[non_exhaustive]
pub struct StateChange {
    pub changed: BTreeMap<Id, BTreeMap<String, State>>,
    pub extra: Map<String, Value>,
}

A state change push notification (RFC 8620 §7.1).

Sent by the server over SSE, WebSocket, or to a PushSubscription URL. The wire form always carries "@type": "StateChange" (RFC 8620 §7.1): serialize always emits it; deserialize rejects any other value, accepts its absence and never leaves it in extra.

extra equality is feature-flag-dependent (bd:JMAP-6r7c.43)

The derived PartialEq / Eq impl compares extra as a serde_json::Map, which is order-insensitive under the workspace default (BTreeMap-backed) and order-sensitive if any crate in the dependency graph enables serde_json/preserve_order.

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.

changed: BTreeMap<Id, BTreeMap<String, State>>

For each account that changed: maps data-type name to the new State token.

Outer key: account Id. Inner key: JMAP data-type name (e.g. "Email"). Inner value: new opaque state string; pass to Email/changes etc. as sinceState.

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md). Never contains @type.

Implementations

impl StateChange

pub fn new(changed: BTreeMap<Id, BTreeMap<String, State>>) -> Self

A StateChange with the given changed map and no extension fields.

Trait Implementations

impl Clone for StateChange

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 StateChange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StateChange

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for StateChange

impl PartialEq for StateChange

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StateChange

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateChange