rust-oxide-realtime 0.2.0

Reusable realtime transport primitives for Axum servers and Rust websocket clients
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
37
38
39
40
41
42
43
44
45
46
47

use std::sync::Arc;

use async_trait::async_trait;

use super::{RealtimeError, SessionAuth, SocketServerHandle};

#[async_trait]
pub trait RealtimeTokenVerifier: Send + Sync + 'static {
    /// Verify an access token and return authenticated session context.
    ///
    /// Returning `Err(RealtimeError::unauthorized(...))` denies websocket upgrade.
    async fn verify_token(&self, token: &str) -> Result<SessionAuth, RealtimeError>;
}

/// Shared application state for realtime HTTP integration.
///
/// This bundles:
/// - `handle`: transport runtime and messaging API.
/// - `verifier`: token verification used during websocket upgrade.
///
/// Use `state.handle` for send/subscribe operations.
#[derive(Clone)]
pub struct SocketAppState {
    pub handle: SocketServerHandle,
    pub verifier: Arc<dyn RealtimeTokenVerifier>,
}

impl SocketAppState {
    /// Create runtime state from a realtime handle and concrete verifier.
    pub fn new<V>(handle: SocketServerHandle, verifier: V) -> Self
    where
        V: RealtimeTokenVerifier,
    {
        Self {
            handle,
            verifier: Arc::new(verifier),
        }
    }

    /// Create runtime state from a realtime handle and shared verifier trait object.
    pub fn new_with_shared_verifier(
        handle: SocketServerHandle,
        verifier: Arc<dyn RealtimeTokenVerifier>,
    ) -> Self {
        Self { handle, verifier }
    }
}