cool_rust_input

Struct CoolInput

Source
pub struct CoolInput<H: CustomInput> {
    pub text: String,
    pub cursor_x: usize,
    pub cursor_y: usize,
    pub scroll_x: usize,
    pub scroll_y: usize,
    pub listening: bool,
    pub custom_input: H,
    pub tab_width: usize,
}
Expand description

The main input type. Uses a custom input handler (a struct which implements CustomInput)

Fields§

§text: String§cursor_x: usize§cursor_y: usize§scroll_x: usize§scroll_y: usize§listening: bool§custom_input: H§tab_width: usize

Implementations§

Source§

impl<H: CustomInput> CoolInput<H>

Source

pub fn new(handler: H, tab_width: usize) -> Self

Source

pub fn render(&mut self) -> Result<(), Error>

Render all text and update cursor

Source

pub fn get_terminal_size(&mut self) -> Result<(u16, u16), Error>

Get the size of the terminal running the program

Source

pub fn handle_key_press(&mut self, key: Event) -> Result<(), Error>

Handle a key event

Source

pub fn listen_quiet(&mut self) -> Result<(), Error>

Start listening for key presses without preparing the terminal

Source

pub fn pre_listen(&mut self) -> Result<(), Error>

Prepare the terminal for input

Source

pub fn post_listen(&mut self) -> Result<(), Error>

Restore the terminal after input is finished.

Source

pub fn listen(&mut self) -> Result<(), Error>

Prepare terminal and start to listen for key presses until finished.

Auto Trait Implementations§

§

impl<H> Freeze for CoolInput<H>
where H: Freeze,

§

impl<H> RefUnwindSafe for CoolInput<H>
where H: RefUnwindSafe,

§

impl<H> Send for CoolInput<H>
where H: Send,

§

impl<H> Sync for CoolInput<H>
where H: Sync,

§

impl<H> Unpin for CoolInput<H>
where H: Unpin,

§

impl<H> UnwindSafe for CoolInput<H>
where H: 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.