Trait portable_pty::MasterPty

source · 
pub trait MasterPty {
    // Required methods
    fn resize(&self, size: PtySize) -> Result<(), Error>;
    fn get_size(&self) -> Result<PtySize, Error>;
    fn try_clone_reader(&self) -> Result<Box<dyn Read + Send>, Error>;
    fn take_writer(&self) -> Result<Box<dyn Write + Send>, Error>;
}
Expand description

Represents the master/control end of the pty

Required Methods§

source

fn resize(&self, size: PtySize) -> Result<(), Error>

Inform the kernel and thus the child process that the window resized. It will update the winsize information maintained by the kernel, and generate a signal for the child to notice and update its state.

source

fn get_size(&self) -> Result<PtySize, Error>

Retrieves the size of the pty as known by the kernel

source

fn try_clone_reader(&self) -> Result<Box<dyn Read + Send>, Error>

Obtain a readable handle; output from the slave(s) is readable via this stream.

source

fn take_writer(&self) -> Result<Box<dyn Write + Send>, Error>

Obtain a writable handle; writing to it will send data to the slave end. Dropping the writer will send EOF to the slave end. It is invalid to take the writer more than once.

Implementors§