CrosstermEngine

Struct CrosstermEngine 

Source
pub struct CrosstermEngine<W: Write> { /* private fields */ }
Expand description

Terminal handing backend implemented with the crossterm crate

Implementations§

Source§

impl<W: Write> CrosstermEngine<W>

Source

pub fn new(buffer: W) -> Self

Trait Implementations§

Source§

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

Source§

type Buffer = CrosstermCommandBuffer<W>

Type of the corresponding command buffer
Source§

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

Creates a new instanse of the CommandBuffer implementation
Source§

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

Renders content to the terminal using the specified rendering commands
Source§

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

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

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

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

Auto Trait Implementations§

§

impl<W> Freeze for CrosstermEngine<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for CrosstermEngine<W>
where W: RefUnwindSafe,

§

impl<W> Send for CrosstermEngine<W>
where W: Send,

§

impl<W> Sync for CrosstermEngine<W>
where W: Sync,

§

impl<W> Unpin for CrosstermEngine<W>
where W: Unpin,

§

impl<W> UnwindSafe for CrosstermEngine<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.