W3cubDocs

/Rust

Struct PipeWriter

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

Write end of an anonymous pipe.

Implementations

impl PipeWriter

1.87.0Source

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.0Source

impl AsFd for PipeWriterAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

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

Borrows the file descriptor. Read more

1.87.0Source

impl AsHandle for PipeWriterAvailable on Windows only.

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

Borrows the handle. Read more

1.87.0Source

impl AsRawFd for PipeWriterAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

1.87.0Source

impl AsRawHandle for PipeWriterAvailable on Windows only.

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle. Read more

1.87.0Source

impl Debug for PipeWriter

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

Formats the value using the given formatter. Read more

1.87.0Source

impl From<OwnedFd> for PipeWriterAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

fn from(owned_fd: OwnedFd) -> Self

Converts to this type from the input type.

1.87.0Source

impl From<OwnedHandle> for PipeWriterAvailable on Windows only.

fn from(owned_handle: OwnedHandle) -> Self

Converts to this type from the input type.

1.87.0Source

impl From<PipeWriter> for OwnedFdAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

1.87.0Source

impl From<PipeWriter> for OwnedHandleAvailable on Windows only.

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

1.87.0Source

impl From<PipeWriter> for Stdio

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

1.87.0Source

impl FromRawFd for PipeWriterAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

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.0Source

impl FromRawHandle for PipeWriterAvailable on Windows only.

unsafe fn from_raw_handle(raw_handle: RawHandle) -> Self

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

1.87.0Source

impl IntoRawFd for PipeWriterAvailable on (Unix or HermitCore or target_os=trusty or WASI or target_os=motor) and non-target_os=trusty only.

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more

1.87.0Source

impl IntoRawHandle for PipeWriterAvailable on Windows only.

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle. Read more

1.87.0Source

impl Write for &PipeWriter

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

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

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

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

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

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

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. Read more

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

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

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

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

Writes a formatted string into this writer, returning any error encountered. Read more

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

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

1.87.0Source

impl Write for PipeWriter

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

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

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

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

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

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

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. Read more

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

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

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

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

Writes a formatted string into this writer, returning any error encountered. Read more

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

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
    T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
    U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

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

The type returned in the event of a conversion error.

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

Performs the conversion.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/io/struct.PipeWriter.html