Struct socketpair::SocketpairStream

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

A socketpair stream, which is a bidirectional bytestream much like a TcpStream 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(&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 AsHandle for SocketpairStream

fn as_handle(&self) -> BorrowedHandle<'_>

Borrows the handle.

impl AsHandleOrSocket for SocketpairStream

fn as_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_>

Like AsHandle::as_handle and AsSocket::as_socket but can return either type.

impl AsRawHandle for SocketpairStream

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

impl AsRawHandleOrSocket for SocketpairStream

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

Like AsRawHandle::as_raw_handle and AsRawSocket::as_raw_socket but can return either type.

impl AsRawReadWriteHandleOrSocket for SocketpairStream

fn as_raw_read_handle_or_socket(&self) -> RawHandleOrSocket

Extracts the raw handle or socket for reading.

fn as_raw_write_handle_or_socket(&self) -> RawHandleOrSocket

Extracts the raw handle or socket for writing.

impl AsReadWriteHandleOrSocket for SocketpairStream

fn as_read_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_>

Extracts the handle or socket for reading.

fn as_write_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_>

Extracts the handle or socket for writing.

impl Debug for SocketpairStream

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

Formats the value using the given formatter.

impl From<SocketpairStream> for OwnedHandle

fn from(stream: SocketpairStream) -> OwnedHandle

Converts to this type from the input type.

impl FromRawHandle for SocketpairStream

unsafe fn from_raw_handle(raw_handle: RawHandle) -> Self

Constructs a new I/O object from the specified raw handle.

impl IntoHandleOrSocket for SocketpairStream

fn into_handle_or_socket(self) -> OwnedHandleOrSocket

Like [IntoHandle::into_handle] and [IntoSocket::into_socket] but can return either type.

impl IntoRawHandle for SocketpairStream

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.

impl IntoRawHandleOrSocket for SocketpairStream

fn into_raw_handle_or_socket(self) -> RawHandleOrSocket

Like IntoRawHandle::into_raw_handle and IntoRawSocket::into_raw_socket but can return either type.

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.

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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    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 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.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

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