Struct RealtimeClient 

pub struct RealtimeClient { /* private fields */ }

Client for Supabase Realtime WebSocket connections.

Wraps Arc<Inner> — cheaply cloneable, Send + Sync.

Implementations

impl RealtimeClient

pub fn new( url: impl Into<String>, api_key: impl Into<String>, ) -> Result<Self, RealtimeError>

Create a new RealtimeClient from a Supabase URL and API key.

pub fn with_config(config: RealtimeConfig) -> Result<Self, RealtimeError>

Create a new RealtimeClient with full configuration.

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

Connect to the Supabase Realtime server via WebSocket.

Establishes the WebSocket connection and starts background reader, heartbeat, and auto-reconnect tasks.

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

Disconnect from the Realtime server.

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

Create a ChannelBuilder for the given name.

The topic will be "realtime:<name>".

pub async fn remove_channel( &self, channel: &RealtimeChannel, ) -> Result<(), RealtimeError>

Remove a channel (unsubscribe and forget).

pub async fn remove_all_channels(&self) -> Result<(), RealtimeError>

Remove all channels.

pub fn channels(&self) -> Vec<RealtimeChannel>

Get a list of all active channels.

pub async fn set_auth(&self, token: &str) -> Result<(), RealtimeError>

Update the auth token for the realtime connection.

If connected, pushes the new access token to the server for each subscribed channel.

Mirrors supabase.realtime.setAuth(token).

pub fn is_connected(&self) -> bool

Check if the client is currently connected.

Trait Implementations

impl Clone for RealtimeClient

fn clone(&self) -> RealtimeClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.