Struct Tui

Source

pub struct Tui<B: Backend> {
    pub events: EventHandler,
    /* private fields */
}

Expand description

Representation of a terminal user interface.

It is responsible for setting up the terminal, initializing the interface and handling the draw events.

Fields§

§events: EventHandler

Terminal event handler.

Implementations§

Source §

impl<B: Backend> Tui

Source

pub fn new(terminal: Terminal, events: EventHandler) -> Self

Constructs a new instance of Tui.

Source

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

Initializes the terminal interface.

It enables the raw mode and sets terminal properties.

Source

pub fn draw(&mut self, app: &mut App<'_>) -> AppResult<()>

Draw the terminal interface by rendering the widgets.

Source

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

Exits the terminal interface.

It disables the raw mode and reverts back the terminal properties.

Trait Implementations§

Source §

impl<B: Debug + Backend> Debug for Tui

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Tui
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, U> Into 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 §