egui_inbox

Crates.ioegui_inbox
lib.rsegui_inbox
version0.4.1
sourcesrc
created_at2023-08-20 20:53:55.203276
updated_at2024-05-06 19:25:11.490913
descriptionUtility to send messages to egui views from async functions, callbacks, etc. without having to use interior mutability.
homepage
repositoryhttps://github.com/lucasmerlin/hello_egui/tree/main/crates/egui_inbox
max_upload_size
id949548
size147,669
(lucasmerlin)

documentation

README

egui_inbox

egui_ver Latest version Documentation unsafe forbidden License

Channel to send messages to egui views from async functions, callbacks, etc. without having to use interior mutability. Will automatically call request_repaint() on the Ui when a message is received.

The goal of this crate is to make interfacing with egui from asynchronous code as easy as possible. Currently it is not optimized for performance, so if you expect to send 1000s of updates per frame you might want to use e.g. std::sync::mpsc instead. Performance might still be improved in the future though.

Example:

use eframe::egui;
use egui::CentralPanel;
use egui_inbox::UiInbox;

pub fn main() -> eframe::Result<()> {
    let inbox = UiInbox::new();
    let mut state = None;

    eframe::run_simple_native(
        "DnD Simple Example",
        Default::default(),
        move |ctx, _frame| {
            CentralPanel::default().show(ctx, |ui| {
                // `read` will return an iterator over all pending messages
                if let Some(last) = inbox.read(ui).last() {
                    state = last;
                }
                // There also is a `replace` method that you can use as a shorthand for the above:
                // inbox.replace(ui, &mut state);

                ui.label(format!("State: {:?}", state));
                if ui.button("Async Task").clicked() {
                    state = Some("Waiting for async task to complete".to_string());
                    let tx = inbox.sender();
                    std::thread::spawn(move || {
                        std::thread::sleep(std::time::Duration::from_secs(1));
                        // Send will return an error if the receiver has been dropped
                        // but unless you have a long running task that will send multiple messages
                        // you can just ignore the error
                        tx.send(Some("Hello from another thread!".to_string())).ok();
                    });
                }
            });
        },
    )
}
Commit count: 259

cargo fmt