Skip to main content

TerminalApp

Struct TerminalApp 

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

Terminal document application state.

Implementations§

Source§

impl TerminalApp

Source

pub fn new(document: IndexDocument, width: usize) -> Self

Creates terminal state from a document and initial wrapping width.

Source

pub fn with_capabilities( document: IndexDocument, width: usize, capabilities: TerminalCapabilities, ) -> Self

Creates terminal state from a document, width, and terminal capabilities.

Source

pub const fn viewport(&self) -> Viewport

Returns the current viewport.

Source

pub const fn mode(&self) -> &InputMode

Returns the current input mode.

Returns whether link hints are visible.

Returns whether the right-side structural sidebar is visible.

Source

pub const fn sidebar_mode(&self) -> SessionSidebarMode

Returns the active right-sidebar mode.

Source

pub const fn reader_profile(&self) -> ReaderProfile

Returns the active reader profile.

Source

pub const fn reader_profile_is_auto(&self) -> bool

Returns whether the reader profile is currently automatic.

Source

pub const fn table_mode(&self) -> TableMode

Returns the active table presentation mode.

Source

pub const fn table_column_offset(&self) -> usize

Returns the zero-based horizontal table column offset.

Source

pub fn set_sidebar_mode(&mut self, mode: SessionSidebarMode)

Sets the active right-sidebar mode from persisted session state.

Source

pub fn set_url_history(&mut self, history: Vec<String>)

Replaces local URL-history suggestions.

Source

pub fn set_response_logs(&mut self, logs: Vec<ResponseLogEntry>)

Replaces local response logs.

Source

pub fn set_reader_profile(&mut self, profile: ReaderProfile)

Sets the active reader profile from CLI input or persisted session state.

Source

pub fn set_reader_profile_auto(&mut self)

Enables automatic reader profile selection for the current document.

Source

pub const fn should_quit(&self) -> bool

Returns whether the app should quit.

Source

pub fn status(&self) -> &str

Returns the status bar text.

Source

pub const fn repair_recipe(&self) -> &RepairRecipe

Returns the current local repair recipe.

Source

pub fn replace_document( &mut self, document: IndexDocument, width: usize, status: String, )

Replaces the current document after an external navigation.

Source

pub fn set_viewport_height(&mut self, height: usize)

Updates the viewport height and clamps the offset.

Source

pub fn handle_key(&mut self, key: KeyEvent) -> AppAction

Handles a terminal key event.

Source

pub fn render(&mut self, frame: &mut Frame<'_>)

Renders the app into a ratatui frame.

Trait Implementations§

Source§

impl Clone for TerminalApp

Source§

fn clone(&self) -> TerminalApp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalApp

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.