Struct Console

pub struct Console { /* private fields */ }

An external console window.

To write to the console, use methods from [AsyncWrite]. To read from the console, use methods from [AsyncRead].

Implementations

impl Console

pub fn new(driver: impl Driver, app: Option<&Path>) -> Result<Self>

Launches a new terminal emulator and returns an object used to read/write to the console of that window.

If app is None, the system default terminal emulator is used.

The terminal emulator will relaunch the current executable with the --relay-console-path argument to specify the path of the pipe/socket used to relay data. Call relay_console with that path in your main function.

pub async fn relay(&mut self, io: impl AsyncRead + AsyncWrite) -> Result<()>

Relays the console contents to and from io.

Trait Implementations

impl AsyncRead for Console

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for Console

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

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

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.