Struct Localizable 

pub struct Localizable {
    pub key: String,
    pub args: Args,
    pub url: Option<String>,
    pub data: Value,
    pub icon: Option<String>,
    pub badge: Option<u32>,
    pub collapse_id: Option<String>,
    pub loc: Option<LocKeys>,
}

A message named rather than written.

key is a Fluent message id whose attributes are .title, .body and optionally .subject (mail only); args are its placeables.

Everything a Notification carries that is not language — the tap target, the icon, the custom payload — is here too, because those do not change with the recipient’s locale.

Fields

key: String

The catalog message id: booking-confirmed.

args: Args

Its placeables: { $coach }, { $count }.

Personal data. A coach’s name, a place, a reference — these are the caller’s values about a person, so they belong in the message that is delivered and nowhere else. Nothing in this module puts one in a log, an event payload or an error.

url: Option<String>

Where a tap should take the recipient.

data: Value

The custom payload the app reads.

icon: Option<String>

An icon for the notification (Web Push).

badge: Option<u32>

A badge count, for a category that declared badge(true).

collapse_id: Option<String>

Coalesces with an undelivered notification carrying the same id.

loc: Option<LocKeys>

The app’s own localisation keys, for a category whose RenderMode is not RenderMode::Server.

These are not this catalog’s ids: they name strings compiled into the iOS and Android apps, which only the app knows. The module cannot invent them, so a caller that wants native rendering passes them, and APNs and FCM get them alongside (or instead of) the server’s text. Web Push has no such mechanism and never sees them.

Implementations

impl Localizable

pub fn new(key: impl Into<String>) -> Self

A message naming key, with no arguments.

pub fn arg(self, name: impl Into<String>, value: impl Into<Value>) -> Self

Adds one placeable.

A number must arrive as a number: Fluent selects the plural form from it, and "2" as a string selects other in every language — which reads correctly in English and wrongly in Polish.

pub fn url(self, url: impl Into<String>) -> Self

Where a tap should take the recipient.

pub fn data(self, data: Value) -> Self

The custom payload the app reads.

pub fn icon(self, icon: impl Into<String>) -> Self

An icon for the notification.

pub fn badge(self, badge: u32) -> Self

A badge count, honoured only by a category that declared badge(true).

pub fn collapse_id(self, id: impl Into<String>) -> Self

Coalesces with an undelivered notification carrying the same id.

pub fn loc(self, loc: LocKeys) -> Self

The app’s own localisation keys — see Localizable::loc.

Trait Implementations

impl Clone for Localizable

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 Localizable

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

Formats the value using the given formatter.

impl Default for Localizable

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Localizable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Localizable> for Message

fn from(localizable: Localizable) -> Self

Converts to this type from the input type.

impl PartialEq for Localizable

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Localizable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Localizable