Struct socketpair::SocketpairStream

#[repr(transparent)]pub struct SocketpairStream(_);

A socketpair stream, which is a bidirectional bytestream much like a UnixStream except that it does not have a name or address.

Implementations

impl SocketpairStream

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

Creates a new independently owned handle to the underlying socket.

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

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.

pub fn num_ready_bytes(&self) -> Result<u64>

Return the number of bytes which are ready to be read immediately.

Trait Implementations

impl AsRawFd for SocketpairStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRawReadWriteFd for SocketpairStream

fn as_raw_read_fd(&self) -> RawFd

Extracts the raw file descriptor for reading.

fn as_raw_write_fd(&self) -> RawFd

Extracts the raw file descriptor for writing.

impl Close for SocketpairStream

fn close(self) -> Result<()>

Drops an I/O writer and closes its contained resource handle (such as a raw file descriptor), ensuring I/O errors resulting from closing this handle are not ignored. The writer is flushed before its handle is closed. If any errors occur during flushing or closing the first such error is returned.

impl Debug for SocketpairStream

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

Formats the value using the given formatter.

impl FromRawFd for SocketpairStream

unsafe fn from_raw_fd(raw_fd: RawFd) -> Self

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

impl IntoRawFd for SocketpairStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl OwnsRaw for SocketpairStream

Safety: SocketpairStream wraps a UnixStream which owns its handle.

impl Read for SocketpairStream

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>

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>

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

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

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

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

Read the exact number of bytes required to fill buf.

pub 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.

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

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

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for SocketpairStream

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>

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<()>

Attempts to write an entire buffer into this writer.

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

🔬 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<()>

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

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

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