Struct Subscription

pub struct Subscription<T: DeserializeOwned + WebSocketNotification> { /* private fields */ }

A Subscription is used to managed a solana websocket rpc method.

Implementations

impl<T: DeserializeOwned + WebSocketNotification> Subscription<T>

pub fn builder() -> SubscriptionBuilder<T, ((), (), (), (), ())>

Create a builder for building Subscription. On the builder, call .receiver(...), .sender(...), .latest(...)(optional), .id(...), .subscription_id(...) to set the values of the fields. Finally, call .build() to create the instance of Subscription.

impl<T: DeserializeOwned + WebSocketNotification> Subscription<T>

pub fn new( ws: &WebSocketProvider, id: u32, subscription_id: SubscriptionId, ) -> Self

pub fn get_unsubscription(&self) -> Unsubscription

Create a struct which will remove this subscription when the run method is called. This is useful since most uses of the subscription will consume the subscription. This can be invoked to store a way of removing the subscription even after it has been consumed in rust. You can also call Subscription::unsubscribe.

use solana_sdk::pubkey::Pubkey;
use wasm_client_solana::LOCALNET;
use wasm_client_solana::LogsSubscribeRequest;
use wasm_client_solana::RpcTransactionLogsFilter;
use wasm_client_solana::SolanaRpcClient;
use wasm_client_solana::prelude::*;

let rpc = SolanaRpcClient::new(LOCALNET);
let subscription = rpc
	.logs_subscribe(
		LogsSubscribeRequest::builder()
			.filter(RpcTransactionLogsFilter::AllWithVotes)
			.build(),
	)
	.await?;
let unsubscription = subscription.get_unsubscription();
let mut stream2 = subscription.clone().take(2);

while let Some(log_notification_request) = stream2.next().await {
	log::info!("The log notification {log_notification_request:#?}");
}

// Can be called even though the `subscription` has been consumed.
unsubscription.run().await?;

pub async fn unsubscribe(&self) -> Result<(), ClientWebSocketError>

This must be called to unsubscribe from the websocket updates. It would be nice if there was a way to automatically do this on Drop. However, I’m not sure how to make async updates on drop. spawn_local was failing.

pub fn id(&self) -> u32

The id originally used to create this subscription. It is also used to uniquely identify the unsubscription call.

pub fn subscription_id(&self) -> SubscriptionId

Get the subscription_id for this Subscription.

Trait Implementations

impl<T: Clone + DeserializeOwned + WebSocketNotification> Clone for Subscription<T>

fn clone(&self) -> Subscription<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: DeserializeOwned + WebSocketNotification> Stream for Subscription<T>

type Item = SubscriptionResponse<T>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T: DeserializeOwned + WebSocketNotification> Unpin for Subscription<T>

where PinnedFieldsOf<__Subscription<'pin, T>>: Unpin,