Skip to main content

Container

Struct Container 

Source
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

Source

pub fn new() -> Self

Source

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

Set terminal height (must be called before render for correct overlay positioning).

Source

pub fn add_child(&mut self, component: Box<dyn Component>)

Source

pub fn remove_child(&mut self, component: &dyn Component)

Source

pub fn clear(&mut self)

Source

pub fn children(&self) -> &[Box<dyn Component>]

Source

pub fn children_mut(&mut self) -> &mut [Box<dyn Component>]

Source

pub fn invalidate_all(&mut self)

Mark all children as needing re-render.

Source

pub fn invalidate_child(&mut self, index: usize)

Mark a specific child as needing re-render by index.

Source

pub fn len(&self) -> usize

Get the number of children.

Source

pub fn pop_child(&mut self) -> Option<Box<dyn Component>>

Remove and return the last child, if any.

Source

pub fn is_empty(&self) -> bool

Check if empty.

Source

pub fn last_child(&self) -> Option<&dyn Component>

Peek at the last child, if any.

Source

pub fn show_overlay( &mut self, component: Box<dyn Component>, options: OverlayOptions, ) -> u64

Show an overlay. Returns the overlay ID for later removal.

Source

pub fn hide_overlay(&mut self, id: u64)

Hide an overlay by ID.

Source

pub fn pop_overlay(&mut self)

Hide the topmost overlay.

Source

pub fn has_overlays(&self) -> bool

Check if there are any visible overlays.

Source

pub fn clear_overlays(&mut self)

Clear all overlays.

Source

pub fn overlay_stack(&self) -> &[OverlayEntry]

Get the overlay stack (for focus management in TUI).

Source

pub fn overlay_stack_mut(&mut self) -> &mut Vec<OverlayEntry>

Trait Implementations§

Source§

impl Component for Container

Source§

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

Handle keyboard input. Return true if consumed.
Source§

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

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)

Clear dirty flag after successful render.
Source§

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)

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>

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>

Get cached render output, if available and valid.
Source§

fn set_cached_render(&mut self, _cache: RenderCache)

Store render output in cache.
Source§

fn is_focusable(&self) -> bool

Whether this component wants focus (for IME cursor positioning).
Source§

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)

Toggle thinking block visibility. No-op by default. Override for components that display thinking content (AssistantMessageComponent).
Source§

impl Default for Container

Source§

fn default() -> Self

Returns the “default value” for a 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
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