Struct Pty

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

Available on crate feature async only.

An allocated pty

Implementations

impl Pty

pub unsafe fn from_fd(fd: OwnedFd) -> Result<Self>

Use the provided file descriptor as a pty.

Safety

The provided file descriptor must be valid, open, belong to a pty, and put into nonblocking mode.

Errors

Returns an error if it fails to be registered with the async runtime.

pub fn resize(&self, size: Size) -> Result<()>

Change the terminal size associated with the pty.

Errors

Returns an error if we were unable to set the terminal size.

pub fn split(&mut self) -> (ReadPty<'_>, WritePty<'_>)

Splits a Pty into a read half and a write half, which can be used to read from and write to the pty concurrently. Does not allocate, but the returned halves cannot be moved to independent tasks.

pub fn into_split(self) -> (OwnedReadPty, OwnedWritePty)

Splits a Pty into a read half and a write half, which can be used to read from and write to the pty concurrently. This method requires an allocation, but the returned halves can be moved to independent tasks. The original Pty instance can be recovered via the OwnedReadPty::unsplit method.

Trait Implementations

impl AsFd for Pty

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

Borrows the file descriptor.

impl AsRawFd for Pty

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for Pty

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for Pty

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl From<Pty> for OwnedFd

fn from(pty: Pty) -> Self

Converts to this type from the input type.