Struct DatabaseChannel 

pub struct DatabaseChannel { /* private fields */ }

Stores notifications in a table, for an in-app notification list.

Uses to_data, falling back to wrapping to_text — so a notification that only wrote a line still gets a row rather than being silently dropped.

Addresses the recipient by their id, not by a route: every notifiable has one, so this channel is never skipped for want of an address.

Implementations

impl DatabaseChannel

pub fn new(db: Database) -> Self

A channel writing to db.

pub fn migrations() -> Migrator

The migration this channel needs.

Merge it into the application’s migrator:

Migrator::new()
    .create_table::<User>("0001_create_users")
    .merge(DatabaseChannel::migrations())

pub async fn for_recipient( &self, notifiable_type: &str, notifiable_id: &str, limit: u64, ) -> Result<Vec<NotificationRow>>

Everything sent to a recipient, newest first.

pub async fn unread( &self, notifiable_type: &str, notifiable_id: &str, limit: u64, ) -> Result<Vec<NotificationRow>>

The unread ones, newest first.

pub async fn unread_count( &self, notifiable_type: &str, notifiable_id: &str, ) -> Result<u64>

How many are unread — what the badge on the bell shows.

pub async fn find_for( &self, notifiable_type: &str, notifiable_id: &str, id: &str, ) -> Result<Option<NotificationRow>>

One notification, but only if it belongs to this recipient.

What an endpoint should look it up with. Reading the row and then comparing the owner in the handler is the same query with one more place to forget the comparison.

pub async fn mark_read(&self, id: &str) -> Result<bool>

Mark one as read. true if it was there and unread.

pub async fn mark_all_read( &self, notifiable_type: &str, notifiable_id: &str, ) -> Result<u64>

Mark everything for a recipient as read. Returns how many changed.

pub async fn prune_read(&self, before: DateTime<Utc>) -> Result<u64>

Delete everything read before before. Returns how many.

A notifications table grows forever otherwise. Worth scheduling.

Trait Implementations

impl Channel for DatabaseChannel

fn name(&self) -> &'static str

The channel’s name.

fn send<'a>(&'a self, delivery: &'a Delivery) -> BoxFuture<'a, Result<()>>

Send it.