Enum Connection

pub enum Connection<S1, S2> {
    Streaming(StreamingConnection<S1>),
    Websocket(WebsocketConnection<S2>),
}

Variants

Streaming(StreamingConnection<S1>)

Websocket(WebsocketConnection<S2>)

Implementations

impl<S1, S2> Connection<S1, S2>

where S1: AsyncRead + AsyncWrite + Unpin, S2: AsyncRead + AsyncWrite + Unpin,

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

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

Read the next incoming server operation.

Errors

Returns an error if reading or decoding the message fails.

pub fn flushes_automatically_when_full(&self) -> bool

pub fn should_flush(&self) -> bool

pub fn may_enqueue_more_ops(&mut self) -> bool

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

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

Convenience function for writing enqueued messages and flushing.

Errors

Returns an error if writing or flushing fails.

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<S1: Debug, S2: Debug> Debug for Connection<S1, S2>

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

Formats the value using the given formatter.