Struct ApplicationLoop

pub struct ApplicationLoop<T: App> { /* private fields */ }

The main event loop for the application.

This is based on the Calloop crate, which provides a cross-platform event loop that can handle multiple sources of events. In this case, we’re using it to handle both the terminal input and the frame timing for the TUI.

Implementations

impl<T: App> ApplicationLoop<T>

pub fn new() -> Result<Self>

Create a new ApplicationLoop.

This will create a new event loop and insert a source for crossterm events.

Examples found in repository

examples/demo.rs (line 10)

fn main() -> Result<()> {
    let mut app_loop = ApplicationLoop::new()?;
    let mut app = DemoApp {
        counter: 0,
        exit_signal: app_loop.exit_signal(),
    };
    app_loop.run(&mut app)
}

pub fn run(&mut self, app: &mut T) -> Result<()>

Run the event loop.

This will run the event loop until the application signals that it should stop. The application will be drawn to the terminal on each frame (60 fps).

Examples found in repository

examples/demo.rs (line 15)

fn main() -> Result<()> {
    let mut app_loop = ApplicationLoop::new()?;
    let mut app = DemoApp {
        counter: 0,
        exit_signal: app_loop.exit_signal(),
    };
    app_loop.run(&mut app)
}

pub fn exit_signal(&self) -> LoopSignal

Get the loop signal.

This can be used to stop the event loop from outside the loop (e.g. when the application should exit).s

Examples found in repository

examples/demo.rs (line 13)

fn main() -> Result<()> {
    let mut app_loop = ApplicationLoop::new()?;
    let mut app = DemoApp {
        counter: 0,
        exit_signal: app_loop.exit_signal(),
    };
    app_loop.run(&mut app)
}