Struct Sender

pub struct Sender(/* private fields */);

Handle to the sending end of an unnamed pipe, created by the pipe() function together with the receiving end.

The core functionality is exposed via the Write trait. The type is convertible to and from handles/file descriptors and allows its internal handle/FD to be borrowed. On Windows, the ShareHandle trait is also implemented.

The handle/file descriptor is inheritable. See module-level documentation for more on how this can be used.

Limbo

On Windows, much like named pipes, unnamed pipes are subject to limbo, meaning that dropping an unnamed pipe does not immediately discard the contents of the send buffer. See the documentation on named_pipe::PipeStream for more.

Trait Implementations

impl AsFd for Sender

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

Borrows the file descriptor.

impl AsRawFd for Sender

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Sender

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

Formats the value using the given formatter.

impl From<OwnedFd> for Sender

fn from(x: OwnedFd) -> Self

Converts to this type from the input type.

impl From<Sender> for OwnedFd

fn from(x: Sender) -> Self

Converts to this type from the input type.

impl FromRawFd for Sender

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for Sender

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl UnnamedPipeExt for Sender

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

Sets whether the nonblocking mode for the pipe half is enabled. By default, it is disabled.

impl Write for Sender

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>

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, args: 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.