Struct conpty::io::PipeReader

pub struct PipeReader { /* private fields */ }

PipeReader wraps a win32 pipe to provide a std::io::Read interface. It also provides a non_blocking mode settings.

Implementations

impl PipeReader

pub fn new(handle: HANDLE) -> Self

Returns a new instance of PipeReader.

pub fn blocking(&mut self, on: bool)

Sets a pipe to a non blocking mode.

It doesn’t changes DUPed handles.

Mainly developed to not pile down libraries to include any windows API crate.

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

Tries to clone a instance to a new one. All cloned instances share the same underlaying data so Reading from one cloned pipe will affect an original pipe.

Trait Implementations

impl Debug for PipeReader

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

Formats the value using the given formatter.

impl Drop for PipeReader

fn drop(&mut self)

Executes the destructor for this type.

impl From<PipeReader> for File

fn from(pipe: PipeReader) -> Self

Converts to this type from the input type.

impl Read for PipeReader

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

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

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.