Struct SubscriptionStream 

pub struct SubscriptionStream { /* private fields */ }

A connected subscription whose background reader surfaces delivered messages.

Construct with SubscriptionStream::open; the background reader starts immediately and runs until the stream is dropped. Pull delivered messages with SubscriptionStream::recv_timeout.

Implementations

impl SubscriptionStream

pub fn open( address: &str, channel: &str, accepted_schemas: Vec<SchemaId>, ) -> Result<Self, SdkError>

Connects to address, performs the handshake, subscribes to channel, and starts the background reader that drains delivered messages.

accepted_schemas is the client’s schema-compatibility list; pass an empty vector to let the server select the channel’s configured schema (the server’s negotiation contract).

Errors

Returns SdkError::Connection when the TCP connection or socket configuration fails, and SdkError::Protocol when the handshake or subscribe is rejected, or the socket cannot be cloned for the reader thread.

pub fn recv_timeout( &self, timeout: Duration, ) -> Result<DeliveredMessage, SdkError>

Blocks up to timeout for the next delivered message from the server.

Errors

Returns SdkError::Connection when no message arrives within timeout or the background reader has stopped (e.g. the server closed the stream).

pub const fn subscription_id(&self) -> u64

The server-assigned id for this subscription.

Trait Implementations

impl Debug for SubscriptionStream

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

Formats the value using the given formatter.

impl Drop for SubscriptionStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.