Trait MasterPty

Source

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

    // Provided methods
    fn process_group_leader(&self) -> Option<i32> { ... }
    fn as_raw_fd(&self) -> Option<i32> { ... }
    fn tty_name(&self) -> Option<PathBuf> { ... }
}

Expand description

Represents the master/control end of the pty.

All methods on this trait are cross-platform. Platform-specific extensions are available via MasterPtyExt (unix only).

Required Methods§

Source

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

Inform the kernel and thus the child process that the window resized.

Source

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

Retrieves the size of the pty as known by the kernel.

Source

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

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

Source

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

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.