pub struct Container { /* private fields */ }Expand description
Container - a component that contains other components rendered vertically. Supports per-child caching and overlay compositing.
Implementations§
Source§impl Container
impl Container
pub fn new() -> Self
Sourcepub fn set_term_height(&mut self, height: usize)
pub fn set_term_height(&mut self, height: usize)
Set terminal height (must be called before render for correct overlay positioning).
pub fn add_child(&mut self, component: Box<dyn Component>)
pub fn remove_child(&mut self, component: &dyn Component)
pub fn clear(&mut self)
pub fn children(&self) -> &[Box<dyn Component>]
pub fn children_mut(&mut self) -> &mut [Box<dyn Component>]
Sourcepub fn invalidate_all(&mut self)
pub fn invalidate_all(&mut self)
Mark all children as needing re-render.
Sourcepub fn invalidate_child(&mut self, index: usize)
pub fn invalidate_child(&mut self, index: usize)
Mark a specific child as needing re-render by index.
Sourcepub fn pop_child(&mut self) -> Option<Box<dyn Component>>
pub fn pop_child(&mut self) -> Option<Box<dyn Component>>
Remove and return the last child, if any.
Sourcepub fn last_child(&self) -> Option<&dyn Component>
pub fn last_child(&self) -> Option<&dyn Component>
Peek at the last child, if any.
Sourcepub fn show_overlay(
&mut self,
component: Box<dyn Component>,
options: OverlayOptions,
) -> u64
pub fn show_overlay( &mut self, component: Box<dyn Component>, options: OverlayOptions, ) -> u64
Show an overlay. Returns the overlay ID for later removal.
Sourcepub fn hide_overlay(&mut self, id: u64)
pub fn hide_overlay(&mut self, id: u64)
Hide an overlay by ID.
Sourcepub fn pop_overlay(&mut self)
pub fn pop_overlay(&mut self)
Hide the topmost overlay.
Sourcepub fn has_overlays(&self) -> bool
pub fn has_overlays(&self) -> bool
Check if there are any visible overlays.
Sourcepub fn clear_overlays(&mut self)
pub fn clear_overlays(&mut self)
Clear all overlays.
Sourcepub fn overlay_stack(&self) -> &[OverlayEntry]
pub fn overlay_stack(&self) -> &[OverlayEntry]
Get the overlay stack (for focus management in TUI).
pub fn overlay_stack_mut(&mut self) -> &mut Vec<OverlayEntry>
Trait Implementations§
Source§impl Component for Container
impl Component for Container
Source§fn render(&mut self, width: usize) -> Vec<String>
fn render(&mut self, width: usize) -> Vec<String>
Render to lines for the given viewport width.
Each returned string MUST NOT exceed
width in visible width.Source§fn handle_input(&mut self, key: &KeyEvent) -> bool
fn handle_input(&mut self, key: &KeyEvent) -> bool
Handle keyboard input. Return
true if consumed.Source§fn invalidate(&mut self)
fn invalidate(&mut self)
Mark this component as needing re-render.
Called when internal state changes (output received, expanded toggled, etc.).
Source§fn is_dirty(&self) -> bool
fn is_dirty(&self) -> bool
Check if this component needs re-render.
Default: false — the Container’s per-child cache tracking determines
whether to re-render. Override to return true for components whose
state can change without explicit invalidation (e.g. ToolExecComponent
receiving streaming output).
Source§fn clear_dirty(&mut self)
fn clear_dirty(&mut self)
Clear dirty flag after successful render.
Source§fn render_padded(&mut self, width: usize) -> Vec<String>
fn render_padded(&mut self, width: usize) -> Vec<String>
Render and pad each line to exactly
width visible columns.
Default implementation calls render(width) and pads each line
with trailing spaces if its visible width is less than width.Source§fn handle_paste(&mut self, _text: &str)
fn handle_paste(&mut self, _text: &str)
Handle a paste event (text from bracketed paste mode).
Default no-op; override to process pasted content.
Source§fn cache_key(&self, _width: usize) -> Option<RenderCacheKey>
fn cache_key(&self, _width: usize) -> Option<RenderCacheKey>
Get the cache key for this component’s current state.
Return None to disable caching (always re-render).
Source§fn get_cached_render(&self) -> Option<&RenderCache>
fn get_cached_render(&self) -> Option<&RenderCache>
Get cached render output, if available and valid.
Source§fn set_cached_render(&mut self, _cache: RenderCache)
fn set_cached_render(&mut self, _cache: RenderCache)
Store render output in cache.
Source§fn is_focusable(&self) -> bool
fn is_focusable(&self) -> bool
Whether this component wants focus (for IME cursor positioning).
Source§fn set_expanded(&mut self, _expanded: bool)
fn set_expanded(&mut self, _expanded: bool)
Toggle expanded/collapsed state. No-op by default.
Override for components that support expand/collapse (tool results, messages, etc.).
Source§fn set_hide_thinking(&mut self, _hide: bool)
fn set_hide_thinking(&mut self, _hide: bool)
Toggle thinking block visibility. No-op by default.
Override for components that display thinking content (AssistantMessageComponent).
Auto Trait Implementations§
impl !RefUnwindSafe for Container
impl !Send for Container
impl !Sync for Container
impl !UnwindSafe for Container
impl Freeze for Container
impl Unpin for Container
impl UnsafeUnpin for Container
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more