Struct Client

pub struct Client { /* private fields */ }

A client connection to a relay.

Implementations

impl Client

pub fn new(relay_url: &str) -> Client

Connect to a relay

pub async fn is_connected(&self) -> bool

Is connected

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

Disconnect from the relay

pub async fn get_auth_state(&self) -> Result<AuthState, Error>

Get auth state

pub async fn wait_for_auth_state_change( &self, timeout: Duration, ) -> Result<AuthState, Error>

Wait for auth state

pub async fn send_authenticate( &self, challenge: String, signer: Arc<dyn Signer>, reconnect_timeout: Duration, ) -> Result<Id, Error>

Authenticate This does not wait for any reply.

pub async fn full_authenticate( &self, signer: Arc<dyn Signer>, timeout: Duration, ) -> Result<(), Error>

Full Authentication process. Run this when you get “auth-required” in an OK or CLOSED message if you wish to authenticate.

pub async fn post_event( &self, event: Event, reconnect_timeout: Duration, ) -> Result<(), Error>

Post an event to the relay

pub async fn post_raw_event( &self, json: String, reconnect_timeout: Duration, ) -> Result<(), Error>

Post a raw event to the relay

pub async fn post_event_and_wait_for_result( &self, event: Event, timeout: Duration, auth: Option<Arc<dyn Signer>>, ) -> Result<(bool, String), Error>

This posts the event, and waits for the OK result, authenticating if requested if auth is Some.

pub async fn wait_for_ok( &self, id: Id, timeout: Duration, ) -> Result<(bool, String), Error>

Wait for an Ok

pub async fn subscribe( &self, filter: Filter, reconnect_timeout: Duration, ) -> Result<SubscriptionId, Error>

Subscribe to a filter. This does not wait for results.

pub async fn close_subscription( &self, sub_id: SubscriptionId, ) -> Result<(), Error>

Close a subscription

pub async fn wait_for_subscribed_event( &self, sub_id: SubscriptionId, timeout: Duration, ) -> Result<Event, Error>

Wait for an event on the given subscription

pub async fn wait_for_subscribed_event_or_eose( &self, sub_id: SubscriptionId, timeout: Duration, ) -> Result<Option<Event>, Error>

Wait for an event on the given subscription

pub async fn subscribe_and_wait_for_events( &self, filter: Filter, timeout: Duration, signer: Option<Arc<dyn Signer>>, ) -> Result<Vec<Event>, Error>

Subscribe and collect all results up to the EOSE

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.