Skip to main content

PushSubscription

Struct PushSubscription 

Source
#[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>, }
Expand description

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)§

This struct is marked as 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§

Source§

impl Clone for PushSubscription

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PushSubscription

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PushSubscription

Source§

impl PartialEq for PushSubscription

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PushSubscription

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PushSubscription

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.