Struct Notifier 

pub struct Notifier { /* private fields */ }

Holds the configured channels and fans a notification out across them.

Bound in the container; resolve it, or reach it through the Notify facade.

struct User(u64);

impl Notifiable for User {
    fn notifiable_id(&self) -> String { self.0.to_string() }
    fn notifiable_type(&self) -> &'static str { "User" }
    fn route_for(&self, _: &str) -> Option<String> { Some(self.0.to_string()) }
}

struct Welcome;

impl Notification<User> for Welcome {
    fn notification_name(&self) -> &'static str { "user.welcome" }
    fn via(&self, _: &User) -> Channels { Channels::new().with::<MemoryChannel>() }
    fn to_text(&self, _: &User) -> Option<String> { Some("hello".into()) }
}

let captured = Arc::new(MemoryChannel::new());
let notifier = Notifier::new().with_arc(Arc::clone(&captured));

notifier.send(&User(7), &Welcome).await?;

assert!(captured.sent_to("user.welcome", "7"));

Implementations

impl Notifier

pub fn new() -> Notifier

A notifier with no channels.

Sending through it delivers nothing and says so per channel — see Sent::NotRegistered.

pub fn with<C>(self, channel: C) -> Notifier

where C: Channel,

Register a channel.

pub fn with_arc<C>(self, channel: Arc<C>) -> Notifier

where C: Channel,

Register an already-shared channel.

For one a test holds a handle to — a MemoryChannel it will assert on.

pub fn has<C>(&self) -> bool

where C: Channel,

Whether a channel of this type is registered.

pub fn channel_names(&self) -> Vec<&'static str>

The registered channels’ names, in registration order.

pub async fn send<N, T>( &self, to: &N, notification: &T, ) -> Result<Receipt, Error>

where N: Notifiable + ?Sized, T: Notification<N> + ?Sized,

Send notification to to.

Every channel the notification selected is tried. A channel failing does not stop the others — an SMTP outage should not also cost the database row that puts the notification in the recipient’s bell menu.

The Receipt says what happened on each. Ok unless every channel failed; call Receipt::into_result to make “nothing got through” an error at the call site.

pub async fn send_to_many<N, T>( &self, to: &[&N], notification: &T, ) -> Vec<Result<Receipt, Error>>

where N: Notifiable + ?Sized, T: Notification<N> + ?Sized,

Send the same notification to several recipients.

One receipt each, in order. A failure for one recipient does not stop the rest — the same reasoning as a failing channel, one level up.

Trait Implementations

impl Debug for Notifier

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

Formats the value using the given formatter.

impl Default for Notifier

fn default() -> Notifier

Returns the “default value” for a type.