Tui

Struct Tui 

Source
pub struct Tui<'a, B: Backend> {
    pub sender: Sender<Event>,
    /* private fields */
}

Fields§

§sender: Sender<Event>

Implementations§

Source§

impl<B: Backend> Tui<'_, B>

Source

pub fn new(terminal: Terminal<B>) -> Self

Source

pub fn run_loop(&mut self, app: &mut App) -> Result<()>

Source

pub fn init(&mut self) -> Result<()>

Initializes the TUI.

get ready for TUI, enable the raw mode and set terminal props.

Source

pub fn term(&mut self) -> Result<()>

Source

pub fn draw(&mut self, app: &mut App) -> Result<()>

Render UI with app state.

Source

pub fn is_running(&self) -> bool

Source

pub fn exit(&mut self) -> Result<()>

Exits the TUI.

cleanup for TUI, disable the raw mode and set terminal props.

Source

pub fn set_search_text(&mut self, text: &str)

Source

pub fn handle_refresh_event(&mut self, _app: &mut App) -> Result<()>

Source

pub fn handle_mouse_events( &mut self, mouse_event: MouseEvent, app: &mut App, ) -> Result<()>

Source

pub fn handle_key_events( &mut self, key_event: KeyEvent, app: &mut App, ) -> Result<()>

Trait Implementations§

Source§

impl<'a, B: Debug + Backend> Debug for Tui<'a, B>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, B> !Freeze for Tui<'a, B>

§

impl<'a, B> RefUnwindSafe for Tui<'a, B>
where B: RefUnwindSafe,

§

impl<'a, B> Send for Tui<'a, B>
where B: Send,

§

impl<'a, B> !Sync for Tui<'a, B>

§

impl<'a, B> Unpin for Tui<'a, B>
where B: Unpin,

§

impl<'a, B> UnwindSafe for Tui<'a, B>
where B: 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more