cratestack-sql 0.18.0

Rust-native schema-first framework for typed HTTP APIs, generated clients, and backend services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! `@@subscribe` on a model descriptor: whether the model's events are
//! notified to the subscription backplane
//! (`docs/design/subscriptions-websocket.md` ยง4.3).

use super::ModelDescriptor;

/// Where a write path enqueues a model event: the model's name, and whether
/// the event must also be notified to subscribers (`@@subscribe`). A model
/// that only `@@emit`s skips the notification, and with it Postgres' commit
/// lock on `NOTIFY`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct EventTarget {
    pub model: &'static str,
    pub notify_subscribers: bool,
}

impl<M, PK> ModelDescriptor<M, PK> {
    /// Mark the model `@@subscribe`. A separate step from
    /// [`ModelDescriptor::new`] so descriptors built without it keep
    /// compiling unchanged.
    pub const fn with_subscribed(self) -> Self {
        Self {
            subscribed: true,
            ..self
        }
    }

    pub const fn event_target(&self) -> EventTarget {
        EventTarget {
            model: self.schema_name,
            notify_subscribers: self.subscribed,
        }
    }
}