Struct StreamingConnection

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

Implementations

impl<S> StreamingConnection<S>

where S: AsyncRead + AsyncWrite + Unpin,

pub fn new(socket: S) -> Self

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

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

Reads the next ServerOp.

Errors

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

pub fn may_write(&self) -> bool

pub fn may_flush(&self) -> bool

pub fn may_enqueue_more_ops(&self) -> bool

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

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

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

Writes the next chunk of data to the socket.

It returns the number of bytes that have been written.

Errors

An I/O error is returned if it is not possible to write to the socket.

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.

pub fn socket(&self) -> &S

pub fn socket_mut(&mut self) -> &mut S

pub fn replace_socket<F, S2>(self, replacer: F) -> StreamingConnection<S2>

where F: FnOnce(S) -> S2,

pub fn into_inner(self) -> S

Trait Implementations

impl<S: Debug> Debug for StreamingConnection<S>

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

Formats the value using the given formatter.