PipeWriter in std::io - Rust
Description: Write end of an anonymous pipe.

## PipeWriter

# Struct PipeWriter

1.87.0 · Source

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

Expand description

Write end of an anonymous pipe.

## Implementations§

Source§

### impl PipeWriter

1.87.0 · Source

#### 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§

1.87.0 · Source§

### impl AsFd for PipeWriter

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

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

Borrows the file descriptor. Read more
1.87.0 · Source§

### impl AsRawFd for PipeWriter

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

#### fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
1.87.0 · Source§

### impl Debug for PipeWriter

Source§

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

Formats the value using the given formatter. Read more
1.87.0 · Source§

### impl From<OwnedFd> for PipeWriter

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

#### fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.
1.87.0 · Source§

### impl From<PipeWriter> for OwnedFd

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

#### fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.
1.87.0 · Source§

### impl From<PipeWriter> for Stdio

Source§

#### fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.
1.87.0 · Source§

### impl FromRawFd for PipeWriter

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

#### unsafe fn from_raw_fd(raw_fd: RawFd) -> Self

Constructs a new instance of `Self` from the given raw file descriptor. Read more
1.87.0 · Source§

### impl IntoRawFd for PipeWriter

Available on (Unix or HermitCore or `target_os=trusty` or WASI or `target_os=motor`) and non-`target_os=trusty` only.
Source§

#### fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more
1.87.0 · Source§

### impl Write for &PipeWriter

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

#### fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

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

Like `write`, except that it writes from a slice of buffers. Read more
Source§

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

#### 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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

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

Creates a “by reference” adapter for this instance of `Write`. Read more
1.87.0 · Source§

### impl Write for PipeWriter

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

#### fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

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

Like `write`, except that it writes from a slice of buffers. Read more
Source§

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

#### 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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

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

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

## Auto Trait Implementations§

§

### impl Freeze for PipeWriter

§

### impl RefUnwindSafe for PipeWriter

§

### impl Send for PipeWriter

§

### impl Sync for PipeWriter

§

### impl Unpin for PipeWriter

§

### impl UnwindSafe for PipeWriter

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.