Struct Realtime

pub struct Realtime { /* private fields */ }

Realtime client for WebSocket subscriptions

Provides cross-platform realtime subscriptions to Supabase database changes.

Examples

Basic subscription

use supabase::{Client, realtime::RealtimeEvent};

let client = Client::new("your-url", "your-key")?;
let realtime = client.realtime();

realtime.connect().await?;

let sub_id = realtime
    .channel("public-posts")
    .table("posts")
    .subscribe(|msg| println!("New post: {:?}", msg))
    .await?;

Implementations

impl Realtime

pub fn new(config: Arc<SupabaseConfig>) -> Result<Self>

Create a new realtime client (works on both native and WASM)

Examples

use supabase::types::SupabaseConfig;
use supabase::realtime::Realtime;
use std::sync::Arc;

let config = Arc::new(SupabaseConfig {
    url: "https://your-project.supabase.co".to_string(),
    key: "your-anon-key".to_string(),
    ..Default::default()
});

let realtime = Realtime::new(config).unwrap();

pub async fn connect(&self) -> Result<()>

Connect to the realtime server (cross-platform)

Examples

let client = Client::new("your-url", "your-key")?;
let realtime = client.realtime();

realtime.connect().await?;
println!("Connected to Supabase realtime!");

pub async fn disconnect(&self) -> Result<()>

Disconnect from the realtime server

Examples

let client = Client::new("your-url", "your-key")?;
let realtime = client.realtime();

realtime.connect().await?;
// ... do work ...
realtime.disconnect().await?;

pub async fn is_connected(&self) -> bool

Check if connected to realtime server

Examples

let client = Client::new("your-url", "your-key")?;
let realtime = client.realtime();

if !realtime.is_connected().await {
    realtime.connect().await?;
}

pub fn channel(&self, _topic: &str) -> ChannelBuilder

Create a channel subscription builder

Examples

let client = Client::new("your-url", "your-key")?;

let subscription = client.realtime()
    .channel("public-posts")
    .table("posts")
    .subscribe(|msg| println!("Update: {:?}", msg))
    .await?;

pub async fn unsubscribe(&self, subscription_id: &str) -> Result<()>

Unsubscribe from a channel

Examples

let client = Client::new("your-url", "your-key")?;
let realtime = client.realtime();

let subscription_id = realtime
    .channel("posts")
    .table("posts")
    .subscribe(|_| {})
    .await?;

// Later...
realtime.unsubscribe(&subscription_id).await?;

pub async fn subscribe<F>( &self, subscription_config: SubscriptionConfig, callback: F, ) -> Result<String>

where F: Fn(RealtimeMessage) + Send + Sync + 'static,

Subscribe to a channel with custom configuration

Trait Implementations

impl Clone for Realtime

fn clone(&self) -> Realtime

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Realtime

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

Formats the value using the given formatter.