Struct ChannelBuilder

pub struct ChannelBuilder { /* private fields */ }

Builder for channel subscriptions

Provides a fluent API for configuring realtime subscriptions.

Examples

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

let subscription = client.realtime()
    .channel("public-posts")
    .table("posts")
    .event(RealtimeEvent::Insert)
    .filter("author_id=eq.123")
    .subscribe(|message| {
        println!("New post by author 123: {:?}", message);
    })
    .await?;

Implementations

impl ChannelBuilder

pub fn table(self, table: &str) -> Self

Set the table to subscribe to

Examples

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

let subscription = client.realtime()
    .channel("posts")
    .table("posts") // Subscribe to the 'posts' table
    .subscribe(|_| {})
    .await?;

pub fn schema(self, schema: &str) -> Self

Set the schema (default: “public”)

Examples

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

let subscription = client.realtime()
    .channel("admin-logs")
    .schema("admin") // Subscribe to 'admin' schema
    .table("logs")
    .subscribe(|_| {})
    .await?;

pub fn event(self, event: RealtimeEvent) -> Self

Set the event type filter

Examples

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

// Only listen to INSERT events
let subscription = client.realtime()
    .channel("new-posts")
    .table("posts")
    .event(RealtimeEvent::Insert)
    .subscribe(|_| {})
    .await?;

pub fn filter(self, filter: &str) -> Self

Set a filter for the subscription

Examples

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

// Only posts by specific author
let subscription = client.realtime()
    .channel("my-posts")
    .table("posts")
    .filter("author_id=eq.123")
    .subscribe(|_| {})
    .await?;

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

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

Subscribe with a callback function

Examples

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

let subscription_id = client.realtime()
    .channel("posts")
    .table("posts")
    .subscribe(|message| {
        match message.event.as_str() {
            "INSERT" => println!("New post created!"),
            "UPDATE" => println!("Post updated!"),
            "DELETE" => println!("Post deleted!"),
            _ => println!("Other event: {}", message.event),
        }
    })
    .await?;