Struct egui_inbox::UiInbox

pub struct UiInbox<T: Debug>(/* private fields */);

Utility to send messages to egui views from async functions, callbacks, etc. without having to use interior mutability. Example:

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

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

    eframe::run_simple_native(
        "DnD Simple Example",
        Default::default(),
        move |ctx, _frame| {
            CentralPanel::default().show(ctx, |ui| {
                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 mut inbox_clone = inbox.clone();
                    std::thread::spawn(move || {
                        std::thread::sleep(std::time::Duration::from_secs(1));
                        inbox_clone.send(Some("Hello from another thread!".to_string()));
                    });
                }
            });
        },
    )
}

Implementations

impl<T: Debug> UiInbox<T>

pub fn new() -> Self

pub fn send(&self, item: T)

Send an item to the inbox. Calling this will request a repaint from egui. If this is called before a call to UiInbox::read was done, no repaint is requested (Since we didn’t have a chance to get a reference to Context yet).

pub fn read(&self, ui: &mut Ui) -> impl Iterator<Item = T>

Returns an iterator over all items sent to the inbox. The inbox is cleared after this call.

The ui is only passed here so we can grab a reference to Context. This is mostly done for convenience, so you don’t have to pass a reference to Context to every struct that uses an inbox on creation.

pub fn replace(&self, ui: &mut Ui, target: &mut T) -> bool

Replaces the value of target with the last item sent to the inbox. Any other updates are discarded. If no item was sent to the inbox, target is not updated. Returns true if target was updated.

The ui is only passed here so we can grab a reference to Context. This is mostly done for convenience, so you don’t have to pass a reference to Context to every struct that uses an inbox on creation.

Trait Implementations

impl<T: Debug> Clone for UiInbox<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Debug> Debug for UiInbox<T>

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

Formats the value using the given formatter.

impl<T: Debug> Default for UiInbox<T>

fn default() -> Self

Returns the “default value” for a type.