Struct Handle 

pub struct Handle { /* private fields */ }

Available on crate feature client only.

A handle to the client service.

This is cheap to clone and can be moved freely between tasks.

Implementations

impl Handle

pub fn state(&self) -> State

Get the current state of the connection.

pub fn is_open(&self) -> bool

Check if the connection is currently open.

pub fn format(&self) -> Format

The Format currently in effect for message bodies.

Before the connection has been opened this is the format which was requested through ServiceBuilder::format. Once the connection is open it is the format the server actually agreed to, which can differ if the server does not support what was asked for.

pub fn on_state_change(&self) -> StateListener

Listen for state changes to the underlying connection.

This indicates when the connection is open and ready to receive requests through State::Open, or if it’s closed and requests will be rejected through State::Closed.

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

Wait until the connection is open.

Since a connection is established asynchronously, this must be called before performing the first request unless you are prepared to handle the Error::is_not_connected error.

This errors if the Service driving the connection is gone, since the connection can then never be established.

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

Open a new logical channel to the websocket server.

A channel can be uniquely identified on the client and server side over a single connection. This means that if you send a request over a channel using Channel::request, the server can access the ChannelId to determine which channel sent the request and the client has the ability to correlate any responses sent by the server by inspecting Packet::channel or RawPacket::channel.

The maximum number of channels is implementation defined, but expect it to be relatively low like 65535 (non-zero 16 bits) to reduce payload sizes. Failure to allocate a channel is an error.

Note that a channel is scoped to the connection it was opened over. If the connection is lost and re-established, any channel opened over the old connection is stale and has to be opened again.

pub fn request(&self) -> RequestBuilder<'_, EmptyBody>

Send a request over the default channel.

See RequestBuilder::send for how the request is completed.

pub fn on_broadcast<T>(&self) -> Listener<T>

where T: Broadcast,

Listen for broadcasts of type T.

Broadcasts are buffered in the returned listener until they are received with Listener::recv. Dropping the listener removes it.

Note that the buffer is unbounded, so a listener which is not drained keeps accumulating broadcasts. Drop or clear a listener which is no longer of interest.

pub fn close(&self)

Close the service.

This causes Service::run to return.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Eq for Handle

impl PartialEq for Handle

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.