Struct WsSink 

pub struct WsSink(/* private fields */);

A clonable handle for sending messages over a WebSocket connection.

Clones share the codec state. The sink is also the connection’s codec, so the dispatcher and all sinks see the same state, e.g. once a close message is sent by either of them, no more messages can be sent.

Implementations

impl WsSink

pub fn io(&self) -> &IoRef

Returns the underlying I/O handle.

pub async fn send(&self, item: Message) -> Result<(), ProtocolError>

Encodes and queues a message for the peer.

Data messages (text, binary and continuation) wait while write back-pressure is enabled, until the write buffer can accept more output. Control messages are queued immediately.

Sending a close message starts the closing handshake. The connection remains open for the peer’s close response and is shut down when the configured closing-handshake timeout expires.

pub fn on_disconnect(&self) -> Waiter<'static>

Returns a future that resolves when the connection is disconnected.

Trait Implementations

impl Clone for WsSink

fn clone(&self) -> WsSink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsSink

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

Formats the value using the given formatter.

impl Decoder for WsSink

type Item = Frame

The type of decoded frames.

type Error = ProtocolError

The type of unrecoverable frame decoding errors.

fn decode(&self, src: &mut BytesMut) -> Result<Option<Frame>, Self::Error>

Attempts to decode a frame from the buffered input.

fn decode_eof(&self, src: &mut BytesMut) -> Result<Option<Frame>, Self::Error>

Attempts to decode a frame once the transport reached a clean EOF.

impl Encoder for WsSink

type Item = Message

The type of frames consumed by the encoder.

type Error = ProtocolError

The type of encoding errors.

fn encode(&self, item: Message, dst: &mut BytePages) -> Result<(), Self::Error>

Encodes a frame and appends it to dst.