pusher_rs

Struct PusherClient

Source 
pub struct PusherClient { /* private fields */ }
Expand description

This struct provides methods for connecting to Pusher, subscribing to channels, triggering events, and handling incoming events.

Implementations§

Source§

impl PusherClient

Source

pub fn new(config: PusherConfig) -> PusherResult<Self>

Creates a new PusherClient instance with the given configuration.

§Arguments
  • config - The configuration for the Pusher client.
§Returns

A PusherResult containing the new PusherClient instance.

Source

pub async fn connect(&mut self) -> PusherResult<()>

Connects to the Pusher server.

§Returns

A PusherResult indicating success or failure.

Source

pub async fn disconnect(&mut self) -> PusherResult<()>

Disconnects from the Pusher server.

§Returns

A PusherResult indicating success or failure.

Source

pub async fn subscribe(&mut self, channel_name: &str) -> PusherResult<()>

Subscribes to a channel.

§Arguments
  • channel_name - The name of the channel to subscribe to.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn subscribe_encrypted( &mut self, channel_name: &str, ) -> PusherResult<()>

Subscribes to an encrypted channel.

§Arguments
  • channel_name - The name of the encrypted channel to subscribe to.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn unsubscribe(&mut self, channel_name: &str) -> PusherResult<()>

Unsubscribes from a channel.

§Arguments
  • channel_name - The name of the channel to unsubscribe from.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn trigger( &self, channel: &str, event: &str, data: &str, ) -> PusherResult<()>

Triggers an event on a channel.

§Arguments
  • channel - The name of the channel to trigger the event on.
  • event - The name of the event to trigger.
  • data - The data to send with the event.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn trigger_encrypted( &self, channel: &str, event: &str, data: &str, ) -> PusherResult<()>

Triggers an event on an encrypted channel.

§Arguments
  • channel - The name of the encrypted channel to trigger the event on.
  • event - The name of the event to trigger.
  • data - The data to send with the event.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn trigger_batch( &self, batch_events: Vec<BatchEvent>, ) -> PusherResult<()>

Triggers multiple events in a single API call.

§Arguments
  • batch_events - A vector of BatchEvent structs, each containing channel, event, and data.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn bind<F>(&self, event_name: &str, callback: F) -> PusherResult<()>
where F: Fn(Event) + Send + Sync + 'static,

Binds a callback to an event.

§Arguments
  • event_name - The name of the event to bind to.
  • callback - The callback function to execute when the event occurs.
§Returns

A PusherResult indicating success or failure.

Source

pub async fn get_connection_state(&self) -> ConnectionState

Gets the current connection state.

§Returns

The current ConnectionState.

Source

pub async fn get_subscribed_channels(&self) -> Vec<String>

Gets a list of currently subscribed channels.

§Returns

A vector of channel names.

Source

pub async fn send_test_event(&self, event: Event) -> PusherResult<()>

Sends a test event through the client.

§Arguments
  • event - The event to send.
§Returns

A PusherResult indicating success or failure.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,