forge-core 0.9.0

Core types and traits for the Forge framework
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
35
36

//! Real-time subscription system.
//!
//! Forge provides automatic real-time updates via PostgreSQL LISTEN/NOTIFY.
//! When tables change, affected subscriptions are invalidated and re-executed.
//!
//! # Architecture
//!
//! ```text
//! Client                Gateway                  PostgreSQL
//!   │                      │                         │
//!   │─── Subscribe ───────>│                         │
//!   │                      │── Execute query ───────>│
//!   │<── Initial data ─────│<── Results ────────────│
//!   │                      │                         │
//!   │                      │<── NOTIFY on change ───│
//!   │                      │── Re-execute query ───>│
//!   │<── Delta update ─────│<── New results ────────│
//! ```
//!
//! # Key Types
//!
//! - [`ReadSet`] - Tables a subscription depends on
//! - [`QueryGroup`] - Coalesced subscriptions sharing query+args+auth_scope
//! - [`Subscriber`] - Lightweight subscriber within a query group
//! - [`Delta`] - Change payload sent to clients

mod readset;
mod session;
mod subscription;

pub use readset::{BloomFilter, Change, ChangeOperation, ReadSet, TrackingMode};
pub use session::{SessionId, SessionInfo, SessionStatus};
pub use subscription::{
    AuthScope, Delta, QueryGroup, QueryGroupId, Subscriber, SubscriberId, SubscriptionId,
    SubscriptionState,
};