Skip to main content

Terminal

Struct Terminal 

Source
pub struct Terminal { /* private fields */ }
Expand description

Terminal wrapper that handles setup, rendering, and cleanup.

Implementations§

Source§

impl Terminal

Source

pub fn new() -> Result<Self>

Create a new terminal instance. Enters raw mode and the alternate screen.

Source

pub fn new_headless(width: u16, height: u16) -> Self

Create a headless terminal for testing. Does not enter raw mode or the alternate screen.

Source

pub fn draw( &mut self, view: &View, focus_index: usize, focus_visible: bool, scroll_offsets: Vec<(u16, u16)>, cursor_offsets: Vec<usize>, modal_visible: bool, ) -> Result<Vec<(u16, u16)>>

Draw a view to the terminal. Returns clamped scroll offsets to apply back to FocusManager.

Source

pub fn height(&self) -> u16

Get the terminal height (useful for page up/down calculations).

Source

pub fn width(&self) -> u16

Get the terminal width.

Source

pub fn buffer_string(&self) -> String

Get the last rendered frame as a string (headless mode). The prev_buffer holds the last drawn frame (after swap in draw()).

Source

pub fn poll_event(&self, timeout: Duration) -> Result<Option<Event>>

Poll for an input event with the given timeout.

Source

pub fn draw_debug( &mut self, frame: u64, render_us: u64, focus_idx: usize, focusable_count: usize, ) -> Result<()>

Draw debug information overlay.

Source

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

Clean up the terminal state.

Trait Implementations§

Source§

impl Drop for Terminal

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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.