Struct PipeStdout

pub struct PipeStdout { /* private fields */ }

Available on crate feature stdio and Unix only.

Locked stdout for asynchronous read.

Implementations

impl PipeStdout

pub fn lock_tokio() -> Result<TokioPipeStdout>

Available on crate feature tokio only.

Shortcut to PipeStdout::lock and then PipeStdout::try_into_tokio.

Errors

Fails if cannot create AsyncFd.

pub fn try_into_tokio(self) -> Result<TokioPipeStdout>

Available on crate feature tokio only.

Register the FD to the tokio runtime and return a tokio compatible writer.

Errors

Fails if cannot create AsyncFd.

impl PipeStdout

pub fn lock() -> Result<Self>

Lock stdout with pipe-like backend and set it to asynchronous mode.

Errors

Fails if the underlying FD is not pipe-like, or error occurs when setting mode. See module level documentation for more details.

Trait Implementations

impl AsFd for PipeStdout

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

Borrows the file descriptor.

impl AsRawFd for PipeStdout

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for PipeStdout

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

Formats the value using the given formatter.

impl Write for &PipeStdout

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.

impl Write for PipeStdout

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.

impl IoSafe for PipeStdout