Skip to main content

Notification

Struct Notification 

Source
pub struct Notification {
Show 13 fields pub title: String, pub body: String, pub category: Option<String>, pub thread_id: Option<String>, pub data: Value, pub collapse_id: Option<String>, pub priority: Priority, pub icon: Option<String>, pub url: Option<String>, pub ttl: Option<Duration>, pub badge: Option<u32>, pub silent: bool, pub loc: Option<LocKeys>,
}
Expand description

One notification, in transport-neutral terms. data is the custom key-value payload the app reads; collapse_id coalesces notifications the user has not seen yet.

Every optional field is a request: an adapter maps what its protocol has and documents what it drops (APNs has no icon, Web Push has no badge).

Fields§

§title: String§body: String§category: Option<String>

The notification category (an app-defined action group).

§thread_id: Option<String>

Groups related notifications in the UI.

§data: Value

Custom payload the app reads; merged alongside the aps block.

§collapse_id: Option<String>

Coalesces with any undelivered notification carrying the same id. apns-collapse-id / android.collapse_key / the Web Push Topic header (≤32 URL-safe characters, so a Web Push adapter shortens it and documents how).

§priority: Priority§icon: Option<String>

An icon for the notification (Web Push icon; ignored by APNs, which takes its icon from the app bundle).

§url: Option<String>

Where a tap should take the user: the Web Push click target, FCM’s click_action, and a top-level url in the APNs payload.

§ttl: Option<Duration>

How long the push service may hold the notification while the device is offline. Serialised as whole seconds, through ttl_secs.

Note the wire forms differ: apns-expiration is an absolute UNIX epoch, so the APNs adapter sends now + ttl; android.ttl is "<s>s"; Web Push TTL is seconds. A zero TTL means “deliver now or drop” in all three.

Sub-second TTLs round up to one second, on the wire and in every adapter: Duration::from_millis(900) is a request to hold the notification briefly, and truncating it to 0 would turn it into the opposite instruction — drop it the moment the device is offline — silently, and again on every serde round trip. Only Duration::ZERO means “drop if undeliverable now”.

§badge: Option<u32>

The badge number to show on the app icon (iOS). Ignored elsewhere.

§silent: bool

A data-only notification: nothing is shown, the app is woken to do work (content-available / FCM data message).

§loc: Option<LocKeys>

Native localisation keys, in place of title/body, where the platform supports them.

Implementations§

Source§

impl Notification

Source

pub fn new(title: impl Into<String>, body: impl Into<String>) -> Self

A minimal notification with a title and body.

Trait Implementations§

Source§

impl Clone for Notification

Source§

fn clone(&self) -> Notification

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 Notification

Source§

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

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

impl<'de> Deserialize<'de> for Notification

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 Notification

Source§

impl PartialEq for Notification

Source§

fn eq(&self, other: &Notification) -> 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 Notification

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 Notification

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> Same for T

Source§

type Output = T

Should always be Self
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.
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