Trait Engine

pub trait Engine {
    type Buffer: CommandBuffer + Clear;

    // Required methods
    fn get_command_buffer(&self) -> Self::Buffer;
    fn render(&mut self, render_commands: &Self::Buffer) -> Result<()>;
    fn finish_rendering(&mut self) -> Result<()>;
    fn read_key(&self) -> Result<Key>;
}

Represents the backend to draw prompts on the screen and handle input

Required Associated Types

type Buffer: CommandBuffer + Clear

Type of the corresponding command buffer

Required Methods

fn get_command_buffer(&self) -> Self::Buffer

Creates a new instanse of the CommandBuffer implementation

fn render(&mut self, render_commands: &Self::Buffer) -> Result<()>

Renders content to the terminal using the specified rendering commands

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

This is called when a prompt is submitted and needs to be rendered in its final state.

fn read_key(&self) -> Result<Key>

Reads a key that was pressed. This is a blocking call

Implementors

impl<W: Write> Engine for CrosstermEngine<W>

type Buffer = CrosstermCommandBuffer<W>