Skip to main content

AppShell

Struct AppShell 

Source
pub struct AppShell {
    pub config: ShellConfig,
    pub registry: ScreenRegistry,
    pub active_screen: Option<ScreenId>,
    pub keymap: Keymap,
    pub overlays: OverlayManager,
    pub palette: CommandPalette,
    pub status_line: StatusLine,
    pub should_quit: bool,
    /* private fields */
}
Expand description

The main app shell that manages screens, chrome, and input dispatch.

Fields§

§config: ShellConfig

Shell configuration.

§registry: ScreenRegistry

Screen registry.

§active_screen: Option<ScreenId>

Currently active screen ID.

§keymap: Keymap

Keymap for input resolution.

§overlays: OverlayManager

Overlay manager.

§palette: CommandPalette

Command palette.

§status_line: StatusLine

Status line content.

§should_quit: bool

Whether the app should quit.

Implementations§

Source§

impl AppShell

Source

pub fn new(config: ShellConfig) -> Self

Create a new app shell with the given config.

Source

pub fn navigate_to(&mut self, id: &ScreenId)

Navigate to a screen by ID.

Source

pub fn next_screen(&mut self)

Navigate to the next screen in tab order.

Source

pub fn prev_screen(&mut self)

Navigate to the previous screen in tab order.

Source

pub fn screen_context(&self, area: Rect) -> ScreenContext

Build the screen context for the current state.

Source

pub fn handle_input(&mut self, event: &InputEvent) -> bool

Handle an input event. Returns true if the app should quit.

Returns the confirmed palette action ID if the user selected a command. Callers should check last_palette_action() after calling this.

Source

pub fn last_palette_action(&self) -> Option<&str>

Get the last palette action confirmed by the user.

Returns Some(action_id) if the user selected an action from the command palette during the last handle_input() call.

Source

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

Render the shell chrome and active screen.

Uses cached layout and tab state to avoid redundant allocations when the terminal dimensions and screen configuration haven’t changed.

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> 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, 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