Struct Runner 

pub struct Runner<A>
where
    A: CoordinatorApp,
{ /* private fields */ }

Core runtime runner coordinating event dispatch and render passes.

Implementations

impl<A> Runner<A>

where A: CoordinatorApp,

pub fn new(app: A) -> Runner<A>

Create a new runner with default configuration.

pub fn with_config(self, config: RunnerConfig) -> Runner<A>

Apply a custom runner configuration.

pub fn coordinator(&self) -> &LayoutCoordinator<A>

Access the underlying coordinator.

pub fn coordinator_mut(&mut self) -> &mut LayoutCoordinator<A>

Mutable access to the underlying coordinator.

pub fn config(&self) -> RunnerConfig

Runner configuration.

pub fn tick_count(&self) -> u64

Current tick count.

pub fn handle_event( &mut self, event: RunnerEvent, ) -> Result<RunnerAction, LayoutError>

Handle a runner event and return the desired action.

pub fn handle_coordinator_event( &mut self, event: CoordinatorEvent, ) -> Result<RunnerAction, LayoutError>

Handle coordinator events that are outside the standard input stream.

pub fn handle_tick( &mut self, tick: TickEvent, ) -> Result<RunnerAction, LayoutError>

Handle a tick event and update the tick counter.

pub fn register_element( &mut self, metadata: ElementMetadata, element: Arc<dyn Element>, ) -> Result<RunnerAction, LayoutError>

Register a new element with the runtime.

pub fn unregister_element( &mut self, id: ElementId, ) -> Result<RunnerAction, LayoutError>

Remove an element from the runtime.

pub fn set_visibility( &mut self, id: ElementId, visibility: Visibility, ) -> Result<RunnerAction, LayoutError>

Update element visibility.

pub fn request_focus( &mut self, request: FocusRequest, ) -> Result<RunnerAction, LayoutError>

Apply a focus change request.

pub fn needs_redraw(&self) -> bool

Whether the runner should redraw based on dirty state.

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

Render all visible elements and clear layout dirty flags.

A resize event must be dispatched before the first render so layout regions have a valid terminal area.

Trait Implementations

impl<A> Debug for Runner<A>

where A: Debug + CoordinatorApp,

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

Formats the value using the given formatter.