Skip to main content

PushClient

Struct PushClient 

Source
pub struct PushClient<C: ChannelKind> { /* private fields */ }
Expand description

Generic multiplexed push client.

Parameterized by C: ChannelKind — the consumer defines their own channel taxonomy. Register handlers with on, then call connect to start receiving frames.

Implementations§

Source§

impl<C: ChannelKind> PushClient<C>

Source

pub fn new(config: ClientConfig) -> Self

Source

pub fn on(&mut self, channel: C, receiver: impl ChannelReceiver<C>)

Register a handler for a channel. Must be called before connect().

Source

pub async fn connect(&mut self) -> Result<(), ConnectError>

Connect to the server. Performs auth handshake and starts the receive loop.

Source

pub async fn send(&self, frame: Frame<C>) -> Result<(), SendError>

Send a frame to the server (client → server).

Source

pub async fn subscribe(&self, channels: &[C]) -> Result<(), SendError>

Subscribe to additional channels after connect.

Source

pub async fn unsubscribe(&self, channels: &[C]) -> Result<(), SendError>

Unsubscribe from channels.

Source

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

Graceful disconnect.

Source

pub fn state(&self) -> ConnectionState

Current connection state.

Source

pub fn cursors(&self) -> HashMap<C, u64>

Per-channel cursor values (for diagnostics / resume).

Auto Trait Implementations§

§

impl<C> Freeze for PushClient<C>

§

impl<C> !RefUnwindSafe for PushClient<C>

§

impl<C> Send for PushClient<C>

§

impl<C> Sync for PushClient<C>

§

impl<C> Unpin for PushClient<C>

§

impl<C> UnsafeUnpin for PushClient<C>

§

impl<C> !UnwindSafe for PushClient<C>

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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