about summary refs log tree commit diff
path: root/src/libcore/task/executor.rs
diff options
context:
space:
mode:
authorJosef Reinhard Brandl <mail@josefbrandl.de>2018-06-26 16:40:42 +0200
committerJosef Reinhard Brandl <mail@josefbrandl.de>2018-06-26 16:40:42 +0200
commit1f9aa1332fc9f0194bac1761ef04e54564e26fc8 (patch)
tree50740ba0d7a3ea05d100ab2b52df077e26b78a68 /src/libcore/task/executor.rs
parent764232cb2a8407c72b9fea68835e686240e30ef3 (diff)
downloadrust-1f9aa1332fc9f0194bac1761ef04e54564e26fc8.tar.gz
rust-1f9aa1332fc9f0194bac1761ef04e54564e26fc8.zip
Split libcore/task.rs into submodules
Diffstat (limited to 'src/libcore/task/executor.rs')
-rw-r--r--src/libcore/task/executor.rs44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/libcore/task/executor.rs b/src/libcore/task/executor.rs
new file mode 100644
index 00000000000..fcef6d5ffc8
--- /dev/null
+++ b/src/libcore/task/executor.rs
@@ -0,0 +1,44 @@
+// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+#![unstable(feature = "futures_api",
+            reason = "futures in libcore are unstable",
+            issue = "50547")]
+
+use super::{TaskObj, SpawnObjError, SpawnErrorKind};
+
+/// A task executor.
+///
+/// A *task* is a `()`-producing async value that runs at the top level, and will
+/// be `poll`ed until completion. It's also the unit at which wake-up
+/// notifications occur. Executors, such as thread pools, allow tasks to be
+/// spawned and are responsible for putting tasks onto ready queues when
+/// they are woken up, and polling them when they are ready.
+pub trait Executor {
+    /// Spawn the given task, polling it until completion.
+    ///
+    /// # Errors
+    ///
+    /// The executor may be unable to spawn tasks, either because it has
+    /// been shut down or is resource-constrained.
+    fn spawn_obj(&mut self, task: TaskObj) -> Result<(), SpawnObjError>;
+
+    /// Determine whether the executor is able to spawn new tasks.
+    ///
+    /// # Returns
+    ///
+    /// An `Ok` return means the executor is *likely* (but not guaranteed)
+    /// to accept a subsequent spawn attempt. Likewise, an `Err` return
+    /// means that `spawn` is likely, but not guaranteed, to yield an error.
+    #[inline]
+    fn status(&self) -> Result<(), SpawnErrorKind> {
+        Ok(())
+    }
+}