1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
use crossbeam::channel::Receiver;
use re_viewer_context::{AsyncRuntimeHandle, WasmNotSend};
/// A handle to an object that is requested asynchronously.
///
/// Note: this object cannot be [`Clone`] because it uses a one-shot channel to track completion of
/// the async operation.
#[derive(Debug)]
pub enum RequestedObject<T: Send + 'static> {
Pending(Receiver<T>),
Completed(T),
}
impl<T: Send + 'static> RequestedObject<T> {
/// Create a new [`Self`] with the given future.
pub fn new<F>(runtime: &AsyncRuntimeHandle, func: F) -> Self
where
T: std::fmt::Debug,
F: std::future::Future<Output = T> + WasmNotSend + 'static,
{
let (tx, rx) = crate::create_channel(1);
let handle = Self::Pending(rx);
runtime.spawn_future(async move {
//TODO(#9836): implement cancellation using another channel (see `make_future_send`)
let result = func.await;
re_quota_channel::send_crossbeam(&tx, result).ok();
});
handle
}
/// Create a new [`Self`] with the given future and automatically request a repaint of the UI
/// when the future completes.
pub fn new_with_repaint<F>(
runtime: &AsyncRuntimeHandle,
egui_ctx: egui::Context,
func: F,
) -> Self
where
T: std::fmt::Debug,
F: std::future::Future<Output = T> + WasmNotSend + 'static,
{
Self::new(runtime, async move {
let result = func.await;
egui_ctx.request_repaint();
result
})
}
/// Check if the future has completed and, if so, update our state to [`Self::Completed`].
pub fn on_frame_start(&mut self) {
let result = match self {
Self::Pending(rx) => rx.try_recv().ok(),
Self::Completed(_) => None,
};
if let Some(result) = result {
*self = Self::Completed(result);
}
}
/// Get a reference to the received object, if the request has completed.
pub fn try_as_ref(&self) -> Option<&T> {
match self {
Self::Pending(_) => None,
Self::Completed(result) => Some(result),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
/// This test is to ensure you think twice before deriving `Clone` for [`RequestedObject`] (see
/// docstring for the background).
#[test]
fn requested_object_not_clone() {
static_assertions::assert_not_impl_any!(RequestedObject<usize>: Clone);
}
}