Skip to main content

PushSubscriptionPatch

Struct PushSubscriptionPatch 

Source
#[non_exhaustive]
pub struct PushSubscriptionPatch<'a> { pub verification_code: Option<&'a str>, pub expires: Patch<&'a UTCDate>, pub types: Patch<&'a [&'a str]>, pub chat_push: Patch<&'a [(&'a Id, ChatPushConfig)]>, }
Expand description

Patch shape for PushSubscription/set update sub-operations (RFC 8620 §7.2.2).

Only the patchable properties are exposed. RFC 8620 §7.2 declares url and keys immutable: to change those, destroy the subscription and create a new one. device_client_id is also stable for the lifetime of the subscription.

Fields left as their default (Patch::Keep / None for verification_code) are omitted from the wire patch and the server leaves the corresponding property unchanged.

The types and chat_push fields use the three-way Patch<T> shape so the (set + clear) conflict is unrepresentable at the type level:

  • Patch::Set replaces the property wholesale (an array of type names for types; a chatPush object built from the supplied (accountId, config) pairs for chat_push).
  • Patch::Clear sends JSON null, removing the property server-side. For types, null means “deliver all types” (RFC 8620 §7.2). For chat_push, null removes all inline-push configuration (draft-atwood-jmap-chat-push-00 §3.1).
  • Patch::Keep (default) omits the key from the patch.

The JMAP Chat Push extension does not define per-key patching of chatPush, so Patch::Set replaces the full map.

§Debug redaction

verification_code is the RFC 8620 §7.2 push-subscription-ownership proof — an attacker who learns the value can claim ownership of the subscription. The Debug impl on this struct redacts it to Some("[REDACTED]") / None so an accidental {:?}-format in an application log, tracing span, or test fixture cannot leak it. Other fields are not secrets and are rendered verbatim.

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.
§verification_code: Option<&'a str>

Replace the verification code (set after receiving a PushVerification payload). None = no change.

RFC 8620 §7.2 ownership proof — redacted by the std::fmt::Debug impl on this struct.

§expires: Patch<&'a UTCDate>

Set or clear the expiry timestamp. Patch::Clear sets expires to null; the server SHOULD then choose a default expiry per RFC 8620 §7.2.

§types: Patch<&'a [&'a str]>

Replace or clear the types filter (RFC 8620 §7.2). Patch::Set installs the array of type names; Patch::Clear sends JSON null so the server delivers all types; Patch::Keep (default) leaves the property unchanged.

§chat_push: Patch<&'a [(&'a Id, ChatPushConfig)]>

Replace or clear the chatPush extension property (draft-atwood-jmap-chat-push-00 §3.1). Patch::Set installs the chatPush map from the supplied (accountId, config) pairs; Patch::Clear sends JSON null so the server removes all inline push config; Patch::Keep (default) leaves the property unchanged.

See the rustdoc on PushSubscriptionCreateInput::chat_push for the rationale behind the slice-of-pairs input shape (vs HashMap<Id, _>).

Trait Implementations§

Source§

impl<'a> Debug for PushSubscriptionPatch<'a>

Source§

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

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

impl<'a> Default for PushSubscriptionPatch<'a>

Source§

fn default() -> PushSubscriptionPatch<'a>

Returns the “default value” for a type. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more