Struct interprocess::unnamed_pipe::UnnamedPipeWriter

pub struct UnnamedPipeWriter { /* fields omitted */ }

A handle to the writing end of an unnamed pipe, created by the pipe function together with the reading end.

The core functionality is exposed in a file-like Write interface. On Windows, the ShareHandle and As-/Into-/FromRawHandle traits are also implemented, along with As-/Into-/FromRawFd on Unix.

Trait Implementations

impl AsRawFd for UnnamedPipeWriter

fn as_raw_fd(&self) -> c_int

Extracts the raw file descriptor.

impl Debug for UnnamedPipeWriter

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

Formats the value using the given formatter.

impl FromRawFd for UnnamedPipeWriter

unsafe fn from_raw_fd(fd: c_int) -> Self

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

impl IntoRawFd for UnnamedPipeWriter

fn into_raw_fd(self) -> c_int

Consumes this object, returning the raw underlying file descriptor.

impl ShareHandle for UnnamedPipeWriter

fn share(&self, reciever: HANDLE) -> Result<HANDLE>

This is supported on Windows only.

Duplicates the handle to make it accessible in the specified process (taken as a handle to that process) and returns the raw value of the handle which can then be sent via some form of IPC, typically named pipes. This is the only way to use any form of IPC other than named pipes to communicate between two processes which do not have a parent-child relationship or if the handle wasn't created as inheritable, therefore named pipes paired with this are a hard requirement in order to communicate between processes if one wasn't spawned by another.

impl Write for UnnamedPipeWriter

fn write(&mut self, data: &[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 is_write_vectored(&self) -> bool

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

Determines if this Writeer 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

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