Struct vsock::VsockStream

pub struct VsockStream { /* fields omitted */ }

A virtio stream between a local and a remote socket.

Methods

impl VsockStream

pub fn connect(addr: &SockAddr) -> Result<Self>

Open a connection to a remote host.

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

Virtio socket address of the remote peer associated with this connection.

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

Virtio socket address of the local address associated with this connection.

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

Shutdown the read, write, or both halves of this connection.

pub fn try_clone(&self) -> Result<Self>

Create a new independently owned handle to the underlying socket.

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Set the timeout on read operations.

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>

Set the timeout on write operations.

pub fn take_error(&self) -> Result<Option<Error>>

Retrieve the latest error associated with the underlying socket.

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Move this stream in and out of nonblocking mode.

Trait Implementations

impl Clone for VsockStream

Important traits for VsockStream

impl Read for VsockStreamimpl Write for VsockStream

fn clone(&self) -> VsockStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VsockStream

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

Formats the value using the given formatter.

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for VsockStream

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

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

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

Flush 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 write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer 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

Creates a "by reference" adaptor for this instance of Write.

impl AsRawFd for VsockStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for VsockStream

unsafe fn from_raw_fd(socket: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for VsockStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.