Struct VsockStream

pub struct VsockStream { /* private fields */ }

An I/O object representing a Virtio socket connected to a remote endpoint.

Implementations

impl VsockStream

pub fn new(connected: VsockStream) -> Result<Self>

pub async fn connect(addr: VsockAddr) -> Result<Self>

Open a connection to a remote host.

pub fn local_addr(&self) -> Result<VsockAddr>

The local address that this socket is bound to.

pub fn peer_addr(&self) -> Result<VsockAddr>

The remote address that this socket is connected to.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shuts down the read, write, or both halves of this connection.

pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>)

Splits a single value implementing AsyncRead + AsyncWrite into separate AsyncRead and AsyncWrite handles.

pub fn into_split(self) -> (OwnedReadHalf, OwnedWriteHalf)

Splits a single value implementing AsyncRead + AsyncWrite into separate AsyncRead and AsyncWrite handles.

To restore this read/write object from its OwnedReadHalf and OwnedWriteHalf use unsplit.

Trait Implementations

impl AsFd for VsockStream

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for VsockStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for VsockStream

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for VsockStream

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Connected for VsockStream

Available on crate feature tonic05 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic06 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic07 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic08 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic09 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic010 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic011 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Connected for VsockStream

Available on crate feature tonic012 only.

Allow consumers of VsockStream to check that it is connected and valid before use.

type ConnectInfo = VsockConnectInfo

The connection info type the IO resources generates.

fn connect_info(&self) -> Self::ConnectInfo

Create type holding information about the connection.

impl Debug for VsockStream

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

Formats the value using the given formatter.

impl IntoRawFd for VsockStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for VsockStream

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for VsockStream

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.