Struct WebsocketConnection

pub struct WebsocketConnection<S> { /* private fields */ }

Implementations

impl<S> WebsocketConnection<S>

where S: AsyncRead + AsyncWrite + Unpin,

pub async fn new(uri: Uri, socket: S) -> Result<Self>

Construct a websocket stream to a pre-established connection socket.

Errors

Returns an error if the websocket handshake fails.

pub fn poll_read_next( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<ServerOp, WebsocketReadError>>

pub async fn read_next(&mut self) -> Result<ServerOp, WebsocketReadError>

Reads the next ServerOp.

Errors

It returns an error if the content cannot be decoded or if an I/O error occurs.

pub fn should_flush(&self) -> bool

pub fn may_enqueue_more_ops(&mut self) -> bool

pub fn enqueue_write_op(&mut self, item: &ClientOp)

Enqueue item to be written.

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

pub async fn flush(&mut self) -> Result<()>

Flush any buffered writes to the connection

Errors

Returns an error if flushing fails

pub async fn shutdown(&mut self) -> Result<()>

Shutdown the connection

Errors

Returns an error if shutting down the connection fails. Implementations usually ignore this error.

Trait Implementations

impl<S: Debug> Debug for WebsocketConnection<S>

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

Formats the value using the given formatter.