Struct TerminalConsole

pub struct TerminalConsole { /* private fields */ }

Implementation of the EndBASIC console to interact with stdin and stdout.

Implementations

impl TerminalConsole

pub fn from_stdio(signals_tx: Sender<Signal>) -> Result<Self>

Creates a new console based on the properties of stdin/stdout.

This spawns a background task to handle console input so this must be run in the context of an Tokio runtime.

pub fn from_stdio_with_injector( signals_tx: Sender<Signal>, ) -> Result<(Self, Sender<Key>)>

Creates a new console based on the properties of stdin/stdout.

This spawns a background task to handle console input so this must be run in the context of an Tokio runtime.

Compared to from_stdio, this also returns a key sender to inject extra events into the queue maintained by the terminal.

Trait Implementations

impl Console for TerminalConsole

fn clear(&mut self, how: ClearType) -> Result<()>

Clears the part of the console given by how.

fn color(&self) -> (Option<u8>, Option<u8>)

Gets the console’s current foreground and background colors.

fn set_color(&mut self, fg: Option<u8>, bg: Option<u8>) -> Result<()>

Sets the console’s foreground and background colors to fg and bg.

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

Enters the alternate console.

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

Hides the cursor.

fn is_interactive(&self) -> bool

Returns true if the console is attached to an interactive terminal. This controls whether reading a line echoes back user input, for example.

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

Leaves the alternate console.

fn locate(&mut self, pos: CharsXY) -> Result<()>

Moves the cursor to the given position, which must be within the screen.

fn move_within_line(&mut self, off: i16) -> Result<()>

Moves the cursor within the line. Positive values move right, negative values move left.

fn print(&mut self, text: &str) -> Result<()>

Writes text to the console, followed by a newline or CRLF pair depending on the needs of the console to advance a line.

fn poll_key<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<Key>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the next key press if any is available.

fn read_key<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Key>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Waits for and returns the next key press.

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

Shows the cursor.

fn size_chars(&self) -> Result<CharsXY>

Queries the size of the text console.

fn write(&mut self, text: &str) -> Result<()>

Writes the text into the console at the position of the cursor.

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

Causes any buffered output to be synced.

fn set_sync(&mut self, enabled: bool) -> Result<bool>

Enables or disables video syncing.

fn size_pixels(&self) -> Result<SizeInPixels, Error>

Queries the size of the graphical console.

fn draw_circle(&mut self, _center: PixelsXY, _radius: u16) -> Result<(), Error>

Draws the outline of a circle at _center with _radius using the current drawing color.

fn draw_circle_filled( &mut self, _center: PixelsXY, _radius: u16, ) -> Result<(), Error>

Draws a filled circle at _center with _radius using the current drawing color.

fn draw_line(&mut self, _x1y1: PixelsXY, _x2y2: PixelsXY) -> Result<(), Error>

Draws a line from _x1y1 to _x2y2 using the current drawing color.

fn draw_pixel(&mut self, _xy: PixelsXY) -> Result<(), Error>

Draws a single pixel at _xy using the current drawing color.

fn draw_rect(&mut self, _x1y1: PixelsXY, _x2y2: PixelsXY) -> Result<(), Error>

Draws the outline of a rectangle from _x1y1 to _x2y2 using the current drawing color.

fn draw_rect_filled( &mut self, _x1y1: PixelsXY, _x2y2: PixelsXY, ) -> Result<(), Error>

Draws a filled rectangle from _x1y1 to _x2y2 using the current drawing color.

impl Drop for TerminalConsole

fn drop(&mut self)

Executes the destructor for this type.