Struct ProgramHandle 

pub struct ProgramHandle<M: Model> { /* private fields */ }

Handle to a running program.

Returned by Program::start() to allow external interaction with the running TUI program. This is particularly useful for SSH applications where events need to be injected from outside the program.

Example

use bubbletea::{Program, Message};

let handle = Program::new(MyModel::default())
    .with_custom_io()
    .start();

// Send a message to the running program
handle.send(MyMessage::DoSomething);

// Wait for the program to finish
let final_model = handle.wait()?;

Implementations

impl<M: Model> ProgramHandle<M>

pub fn send<T: Into<Message>>(&self, msg: T) -> bool

Send a message to the running program.

This queues the message for processing in the program’s event loop. Returns true if the message was sent successfully, false if the program has already exited.

pub fn quit(&self)

Request the program to quit.

This sends a QuitMsg to the program’s event loop.

pub fn wait(self) -> Result<M>

Wait for the program to finish and return the final model state.

This blocks until the program exits.

pub fn is_running(&self) -> bool

Check if the program is still running.