Struct PtyConsole 

pub struct PtyConsole { /* private fields */ }

PTY (pseudo-terminal) console backend.

Provides a real terminal interface that can be connected to by terminal emulators or the host shell.

Implementations

impl PtyConsole

pub fn new() -> Result<Self>

Creates a new PTY console.

Errors

Returns an error if PTY allocation fails.

pub fn slave_path(&self) -> &str

Returns the path to the slave PTY device.

Users can connect to this path with a terminal emulator:

• screen /dev/pts/X
• minicom -D /dev/pts/X

pub const fn master_fd(&self) -> RawFd

Returns the master file descriptor.

pub fn set_nonblocking(&mut self, nonblocking: bool) -> Result<()>

Sets non-blocking mode on the master.

pub fn set_window_size(&self, rows: u16, cols: u16) -> Result<()>

Sets terminal size.

pub fn has_data(&self) -> bool

Checks if data is available to read.

Trait Implementations

impl ConsoleIo for PtyConsole

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

Reads data from the console (host -> guest).

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

Writes data to the console (guest -> host).

fn flush(&mut self) -> Result<()>

Flushes pending output.

impl Drop for PtyConsole

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.