Struct PushSubscription 

#[non_exhaustive]
pub struct PushSubscription {
    pub id: Option<Id>,
    pub device_client_id: String,
    pub url: Option<String>,
    pub keys: Option<PushKeys>,
    pub verification_code: Option<String>,
    pub expires: Option<UTCDate>,
    pub types: Option<Vec<String>>,
    pub extra: Map<String, Value>,
}

A push subscription (RFC 8620 §7.2).

Every property other than deviceClientId is optional here because the same type carries a create request (no id, verificationCode or expires), a PushSubscription/get result (url and keys are never returned, RFC 8620 §7.2.1), and the server’s stored record. None fields are omitted on serialize; a JSON null deserializes to None.

Extension properties, such as chatPush from draft-atwood-jmap-chat-push-00, are carried in extra.

The Debug impl redacts url, keys.auth and verificationCode.

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.

id: Option<Id>

The id property: server-set and immutable.

device_client_id: String

The deviceClientId property: identifies the client and device.

url: Option<String>

The url property: absolute URL the server POSTs pushes to. The RFC requires it to begin with "https://"; this type does not check that.

keys: Option<PushKeys>

The keys property: RFC 8291 encryption keys, or None for none.

verification_code: Option<String>

The verificationCode property: None until the client echoes the code from the PushVerification.

expires: Option<UTCDate>

The expires property: the server sends nothing after this time.

types: Option<Vec<String>>

The types property: data types to push; None means all types.

extra: Map<String, Value>

Catch-all for extension properties (e.g. chatPush) and vendor / site / private fields not covered by the typed fields above, per workspace extras-preservation policy (see workspace AGENTS.md).

Trait Implementations

impl Clone for PushSubscription

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 PushSubscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PushSubscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PushSubscription

impl JmapObject for PushSubscription

PushSubscription has no property selector enum; PushSubscription/get takes property names directly.

const TYPE_NAME: &'static str = "PushSubscription"

The JMAP type name string (e.g. "Email", "Mailbox", "Chat").

type Property = ()

The property selector enum for this type (server-side only, no serde).

impl PartialEq for PushSubscription

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PushSubscription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetObject for PushSubscription

Property attributes from RFC 8620 §7.2 (rfc8620.txt:3593, 3597, 3618, 3623): id is “(immutable; server-set)”; deviceClientId, url and keys are “(immutable)”; verificationCode, expires and types carry no attribute.

const SERVER_SET: &'static [&'static str]

Wire names of the properties the spec marks “server-set”: “Only the server can set the value for this property. The client MUST NOT send this property when creating a new object of this type.” (RFC 8620 §1.1). A property the type’s /set method text never accepts from a client, on create or update, is server-set too.

const CLIENT_SETTABLE: &'static [&'static str]

Wire names of every property that is not SERVER_SET: the ones a client may set through /set.

const IMMUTABLE: &'static [&'static str]

The CLIENT_SETTABLE properties the spec marks “immutable”: “The value MUST NOT change after the object is created.” (RFC 8620 §1.1). A property the /set method text accepts on create but not on update is immutable too.

type Patch = PatchObject

The patch type for update operations.

impl StructuralPartialEq for PushSubscription