Struct Client

pub struct Client { /* private fields */ }

The Relay WebSocket RPC client.

This provides the high-level access to all of the available RPC methods. For a lower-level RPC stream see ClientStream.

Implementations

impl Client

pub fn new<T>(handler: T) -> Self

where T: ConnectionHandler,

Creates a new Client with the provided handler.

pub fn publish( &self, topic: Topic, message: impl Into<Arc<str>>, attestation: impl Into<Option<Arc<str>>>, tag: u32, ttl: Duration, prompt: bool, ) -> EmptyResponseFuture<Publish>

Publishes a message over the network on given topic.

pub fn subscribe(&self, topic: Topic) -> ResponseFuture<Subscribe>

Subscribes on topic to receive messages. The request is resolved optimistically as soon as the relay receives it.

pub fn subscribe_blocking( &self, topic: Topic, ) -> ResponseFuture<SubscribeBlocking>

Subscribes on topic to receive messages. The request is resolved only when fully processed by the relay. Note: This function is experimental and will likely be removed in the future.

pub fn unsubscribe(&self, topic: Topic) -> EmptyResponseFuture<Unsubscribe>

Unsubscribes from a topic.

pub fn fetch(&self, topic: Topic) -> ResponseFuture<FetchMessages>

Fetch mailbox messages for a specific topic.

pub fn fetch_stream(&self, topics: impl Into<Vec<Topic>>) -> FetchMessageStream

Fetch mailbox messages for a specific topic. Returns a [Stream].

pub fn batch_subscribe( &self, topics: impl Into<Vec<Topic>>, ) -> ResponseFuture<BatchSubscribe>

Subscribes on multiple topics to receive messages. The request is resolved optimistically as soon as the relay receives it.

pub fn batch_subscribe_blocking( &self, topics: impl Into<Vec<Topic>>, ) -> impl Future<Output = Result<Vec<Result<SubscriptionId, Error<SubscriptionError>>>, Error<SubscriptionError>>>

Subscribes on multiple topics to receive messages. The request is resolved only when fully processed by the relay. Note: This function is experimental and will likely be removed in the future.

pub fn batch_unsubscribe( &self, subscriptions: impl Into<Vec<Unsubscribe>>, ) -> EmptyResponseFuture<BatchUnsubscribe>

Unsubscribes from multiple topics.

pub fn batch_fetch( &self, topics: impl Into<Vec<Topic>>, ) -> ResponseFuture<BatchFetchMessages>

Fetch mailbox messages for multiple topics.

pub async fn batch_receive( &self, receipts: impl Into<Vec<Receipt>>, ) -> ResponseFuture<BatchReceiveMessages>

Acknowledge receipt of messages from a subscribed client.

pub async fn connect(&self, opts: &ConnectionOptions) -> Result<(), ClientError>

Opens a connection to the Relay.

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

Closes the Relay connection.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.