summaryrefslogtreecommitdiff
path: root/helix-term/src/job.rs
diff options
context:
space:
mode:
authorJoe Neeman2021-06-28 12:48:38 +0000
committerBlaž Hrastnik2021-06-30 08:08:50 +0000
commitd64d75e72434842f2cceff2c77a03efab5e7a0bc (patch)
tree6c296d23d2d3fea0f0bd5d84d6cd9cda4c36c96c /helix-term/src/job.rs
parentc9be480bf86489fbf659b45b107be0d26a076b50 (diff)
Add some async job infrastructure.
Diffstat (limited to 'helix-term/src/job.rs')
-rw-r--r--helix-term/src/job.rs100
1 files changed, 100 insertions, 0 deletions
diff --git a/helix-term/src/job.rs b/helix-term/src/job.rs
new file mode 100644
index 00000000..fcecfbce
--- /dev/null
+++ b/helix-term/src/job.rs
@@ -0,0 +1,100 @@
+use helix_view::Editor;
+
+use crate::compositor::Compositor;
+
+use futures_util::future::{self, BoxFuture, Future, FutureExt};
+use futures_util::stream::{self, FuturesUnordered, Select, StreamExt};
+
+pub type Callback = Box<dyn FnOnce(&mut Editor, &mut Compositor) + Send>;
+pub type JobFuture = BoxFuture<'static, anyhow::Result<Option<Callback>>>;
+
+pub struct Job {
+ pub future: BoxFuture<'static, anyhow::Result<Option<Callback>>>,
+ /// Do we need to wait for this job to finish before exiting?
+ pub wait: bool,
+}
+
+#[derive(Default)]
+pub struct Jobs {
+ futures: FuturesUnordered<JobFuture>,
+ /// These are the ones that need to complete before we exit.
+ wait_futures: FuturesUnordered<JobFuture>,
+}
+
+impl Job {
+ pub fn new<F: Future<Output = anyhow::Result<()>> + Send + 'static>(f: F) -> Job {
+ Job {
+ future: f.map(|r| r.map(|()| None)).boxed(),
+ wait: false,
+ }
+ }
+
+ pub fn with_callback<F: Future<Output = anyhow::Result<Callback>> + Send + 'static>(
+ f: F,
+ ) -> Job {
+ Job {
+ future: f.map(|r| r.map(|x| Some(x))).boxed(),
+ wait: false,
+ }
+ }
+
+ pub fn wait_before_exiting(mut self) -> Job {
+ self.wait = true;
+ self
+ }
+}
+
+impl Jobs {
+ pub fn new() -> Jobs {
+ Jobs::default()
+ }
+
+ pub fn spawn<F: Future<Output = anyhow::Result<()>> + Send + 'static>(&mut self, f: F) {
+ self.add(Job::new(f));
+ }
+
+ pub fn callback<F: Future<Output = anyhow::Result<Callback>> + Send + 'static>(
+ &mut self,
+ f: F,
+ ) {
+ self.add(Job::with_callback(f));
+ }
+
+ pub fn handle_callback(
+ &mut self,
+ editor: &mut Editor,
+ compositor: &mut Compositor,
+ call: anyhow::Result<Option<Callback>>,
+ ) {
+ match call {
+ Ok(None) => {}
+ Ok(Some(call)) => {
+ call(editor, compositor);
+ }
+ Err(e) => {
+ editor.set_error(format!("Async job failed: {}", e));
+ }
+ }
+ }
+
+ pub fn next<'a>(
+ &'a mut self,
+ ) -> impl Future<Output = Option<anyhow::Result<Option<Callback>>>> + 'a {
+ future::select(self.futures.next(), self.wait_futures.next())
+ .map(|either| either.factor_first().0)
+ }
+
+ pub fn add(&mut self, j: Job) {
+ if j.wait {
+ self.wait_futures.push(j.future);
+ } else {
+ self.futures.push(j.future);
+ }
+ }
+
+ /// Blocks until all the jobs that need to be waited on are done.
+ pub fn finish(&mut self) {
+ let wait_futures = std::mem::take(&mut self.wait_futures);
+ helix_lsp::block_on(wait_futures.for_each(|_| future::ready(())));
+ }
+}