Struct WebSocketSender 

pub struct WebSocketSender<S> {
    pub(crate) shared: Arc<Shared<S>>,
}

The sender part of a websocket stream.

Fields

shared: Arc<Shared<S>>

Implementations

impl<S> WebSocketSender<S>

pub async fn send(&mut self, msg: Message) -> Result<(), WsError>

where S: AsyncRead + AsyncWrite + Unpin,

Send a message via websocket.

pub async fn close(&mut self, msg: Option<CloseFrame>) -> Result<(), WsError>

where S: AsyncRead + AsyncWrite + Unpin,

Close the underlying websocket.

pub fn is_pair_of(&self, other: &WebSocketReceiver<S>) -> bool

Checks if this sender and some receiver were split from the same websocket stream.

Trait Implementations

impl<S: Debug> Debug for WebSocketSender<S>

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

Formats the value using the given formatter.

impl<T> Sink<Message> for WebSocketSender<T>

where T: AsyncRead + AsyncWrite + Unpin,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.