Struct PipeWriter

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

Write end of an anonymous pipe.

Implementations

impl PipeWriter

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

Creates a new PipeWriter instance that shares the same underlying file description.

Examples

use std::process::Command;
use std::io::{pipe, Read};
let (mut reader, writer) = pipe()?;

// Spawn a process that writes to stdout and stderr.
let mut peer = Command::new("bash")
    .args([
        "-c",
        "echo -n foo\n\
         echo -n bar >&2"
    ])
    .stdout(writer.try_clone()?)
    .stderr(writer)
    .spawn()?;

// Read and check the result.
let mut msg = String::new();
reader.read_to_string(&mut msg)?;
assert_eq!(&msg, "foobar");

peer.wait()?;

Trait Implementations

impl AsFd for PipeWriter

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

Borrows the file descriptor.

impl AsHandle for PipeWriter

Available on Windows only.

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

Borrows the handle.

impl AsRawFd for PipeWriter

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRawHandle for PipeWriter

Available on Windows only.

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

impl Debug for PipeWriter

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

Formats the value using the given formatter.

impl From<OwnedFd> for PipeWriter

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<OwnedHandle> for PipeWriter

Available on Windows only.

fn from(owned_handle: OwnedHandle) -> Self

Converts to this type from the input type.

impl From<PipeWriter> for OwnedFd

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

impl From<PipeWriter> for OwnedHandle

Available on Windows only.

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

impl From<PipeWriter> for Stdio

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

impl FromRawFd for PipeWriter

unsafe fn from_raw_fd(raw_fd: RawFd) -> Self

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

impl FromRawHandle for PipeWriter

Available on Windows only.

unsafe fn from_raw_handle(raw_handle: RawHandle) -> Self

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

impl IntoRawFd for PipeWriter

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl IntoRawHandle for PipeWriter

Available on Windows only.

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.

impl Write for &PipeWriter

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 #69941)

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 #70436)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<()>

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.

impl Write for PipeWriter

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 #69941)

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 #70436)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<()>

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.