Struct endbasic_std::testutils::MockConsole

pub struct MockConsole { /* private fields */ }

A console that supplies golden input and captures all output.

Implementations

impl MockConsole

pub fn add_input_chars(&mut self, s: &str)

Adds a bunch of characters as golden input keys.

Note that some escape characters within s are interpreted and added as their corresponding Keys for simplicity.

pub fn add_input_keys(&mut self, keys: &[Key])

Adds a bunch of keys as golden input.

pub fn captured_out(&self) -> &[CapturedOut]

Obtains a reference to the captured output.

pub fn take_captured_out(&mut self) -> Vec<CapturedOut>

Takes the captured output for separate analysis.

pub fn set_size_chars(&mut self, size: CharsXY)

Sets the size of the mock text console.

pub fn set_size_pixels(&mut self, size: SizeInPixels)

Sets the size of the mock graphical console.

pub fn set_interactive(&mut self, interactive: bool)

Sets whether the mock console is interactive or not.

Trait Implementations

impl Console for MockConsole

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 size_pixels(&self) -> Result<SizeInPixels>

Queries the size of the graphical console.

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

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

fn draw_circle(&mut self, xy: PixelsXY, r: u16) -> Result<()>

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

fn draw_circle_filled(&mut self, xy: PixelsXY, r: u16) -> Result<()>

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

fn draw_line(&mut self, x1y1: PixelsXY, x2y2: PixelsXY) -> Result<()>

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

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

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

fn draw_rect(&mut self, x1y1: PixelsXY, x2y2: PixelsXY) -> Result<()>

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

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

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.

impl Default for MockConsole

fn default() -> Self

Returns the “default value” for a type.