blob: 131fca5b3eaa0337fae7d1dbd595860f8840b95e (
plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
use crate::runtime;
use crate::task::JoinHandle;
use std::future::Future;
doc_rt_core! {
/// Spawns a new asynchronous task, returning a
/// [`JoinHandle`](super::JoinHandle) for it.
///
/// Spawning a task enables the task to execute concurrently to other tasks. The
/// spawned task may execute on the current thread, or it may be sent to a
/// different thread to be executed. The specifics depend on the current
/// [`Runtime`](crate::runtime::Runtime) configuration.
///
/// There is no guarantee that a spawned task will execute to completion.
/// When a runtime is shutdown, all outstanding tasks are dropped,
/// regardless of the lifecycle of that task.
///
/// # Examples
///
/// In this example, a server is started and `spawn` is used to start a new task
/// that processes each received connection.
///
/// ```no_run
/// use tokio::net::{TcpListener, TcpStream};
///
/// use std::io;
///
/// async fn process(socket: TcpStream) {
/// // ...
/// # drop(socket);
/// }
///
/// #[tokio::main]
/// async fn main() -> io::Result<()> {
/// let mut listener = TcpListener::bind("127.0.0.1:8080").await?;
///
/// loop {
/// let (socket, _) = listener.accept().await?;
///
/// tokio::spawn(async move {
/// // Process each socket concurrently.
/// process(socket).await
/// });
/// }
/// }
/// ```
///
/// # Panics
///
/// Panics if called from **outside** of the Tokio runtime.
///
/// # Using `!Send` values from a task
///
/// The task supplied to `spawn` must implement `!Send`. However, it is
/// possible to **use** `!Send` values from the task as long as they only
/// exist between calls to `.await`.
///
/// For example, this will work:
///
/// ```
/// use tokio::task;
///
/// use std::rc::Rc;
///
/// fn use_rc(rc: Rc<()>) {
/// // Do stuff w/ rc
/// # drop(rc);
/// }
///
/// #[tokio::main]
/// async fn main() {
/// tokio::spawn(async {
/// // Force the `Rc` to stay in a scope with no `.await`
/// {
/// let rc = Rc::new(());
/// use_rc(rc.clone());
/// }
///
/// task::yield_now().await;
/// }).await.unwrap();
/// }
/// ```
///
/// This will **not** work:
///
/// ```compile_fail
/// use tokio::task;
///
/// use std::rc::Rc;
///
/// fn use_rc(rc: Rc<()>) {
/// // Do stuff w/ rc
/// # drop(rc);
/// }
///
/// #[tokio::main]
/// async fn main() {
/// tokio::spawn(async {
/// let rc = Rc::new(());
///
/// task::yield_now().await;
///
/// use_rc(rc.clone());
/// }).await.unwrap();
/// }
/// ```
///
/// Holding on to a `!Send` value across calls to `.await` will result in
/// an unfriendly compile error message similar to:
///
/// ```text
/// `[... some type ...]` cannot be sent between threads safely
/// ```
///
/// or:
///
/// ```text
/// error[E0391]: cycle detected when processing `main`
/// ```
pub fn spawn<T>(task: T) -> JoinHandle<T::Output>
where
T: Future + Send + 'static,
T::Output: Send + 'static,
{
runtime::spawn(task)
}
}
|