Struct SubscriptionConfig 

pub struct SubscriptionConfig {
    pub id: String,
    pub sql: String,
    pub options: Option<SubscriptionOptions>,
    pub ws_url: Option<String>,
}

Configuration for establishing a WebSocket subscription.

Fields

id: String

Subscription identifier (client-generated, required)

sql: String

SQL query to register for live updates

options: Option<SubscriptionOptions>

Optional subscription options (e.g., last_rows)

ws_url: Option<String>

Override WebSocket URL (falls back to base_url conversion when None)

Implementations

impl SubscriptionConfig

pub fn new(id: impl Into<String>, sql: impl Into<String>) -> SubscriptionConfig

Create a new configuration with required ID and SQL.

By default, includes empty subscription options (batch streaming configured server-side).

pub fn without_initial_data( id: impl Into<String>, sql: impl Into<String>, ) -> SubscriptionConfig

Create a configuration without any initial data fetch.

Trait Implementations

impl Clone for SubscriptionConfig

fn clone(&self) -> SubscriptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionConfig

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

Formats the value using the given formatter.