Struct PtyFd 

pub struct PtyFd(pub FileDescriptor);

Tuple Fields

0: FileDescriptor

Methods from Deref<Target = FileDescriptor>

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

Attempt to duplicate the underlying handle and return a FileDescriptor wrapped around the duplicate. Since the duplication requires kernel resources that may not be available, this is a potentially fallible operation. The returned handle has a separate lifetime from the source, but references the same object at the kernel level.

pub fn as_stdio(&self) -> Result<Stdio, Error>

A convenience method for creating a std::process::Stdio object to be used for eg: redirecting the stdio streams of a child process. The Stdio is created using a duplicated handle so that the source handle remains alive.

pub fn as_file(&self) -> Result<File, Error>

A convenience method for creating a std::fs::File object. The File is created using a duplicated handle so that the source handle remains alive.

pub fn set_non_blocking(&mut self, non_blocking: bool) -> Result<(), Error>

Attempt to change the non-blocking IO mode of the file descriptor. Not all kinds of file descriptor can be placed in non-blocking mode on all systems, and some file descriptors will claim to be in non-blocking mode but it will have no effect. File descriptors based on sockets are the most portable type that can be successfully made non-blocking.

Trait Implementations

impl Deref for PtyFd

type Target = FileDescriptor

The resulting type after dereferencing.

fn deref(&self) -> &FileDescriptor

Dereferences the value.

impl DerefMut for PtyFd

fn deref_mut(&mut self) -> &mut FileDescriptor

Mutably dereferences the value.

impl Read for PtyFd

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

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>) -> Result<usize, Error>

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

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

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

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

Reads 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)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.