eater/async-std
1
0
Fork 0
forked from mirror/async-std
Code Issues Pull requests Releases Wiki Activity

rename task::blocking to task::spawn_blocking

Browse source 
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
This commit is contained in:
Yoshua Wuyts 2019-10-09 22:24:38 +02:00
parent b4c1c63fd2
commit 12fdc1232d
No known key found for this signature in database
GPG key ID: 24EA8164F96777ED
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/task/block_on.rs
View file

@ -21,7 +21,7 @@ use kv_log_macro::trace;
///
/// See also: [`task::blocking`].
///
/// [`task::blocking`]: fn.blocking.html
/// [`task::spawn_blocking`]: fn.spawn_blocking.html
///
/// [spawning]: https://doc.rust-lang.org/std/thread/fn.spawn.html
/// [joining]: https://doc.rust-lang.org/std/thread/struct.JoinHandle.html#method.join

9
src/task/mod.rs
View file

@ -60,9 +60,10 @@ cfg_if::cfg_if! {
/// is useful to prevent long-running synchronous operations from blocking the main futures
/// executor.
///
/// See also: [`task::block_on`].
/// See also: [`task::block_on`], [`task::spawn`].
///
/// [`task::block_on`]: fn.block_on.html
/// [`task::spawn`]: fn.spawn.html
///
/// # Examples
///
@ -73,7 +74,7 @@ cfg_if::cfg_if! {
/// #
/// use async_std::task;
///
/// task::blocking(|| {
/// task::spawn_blocking(|| {
/// println!("long-running task here");
/// }).await;
/// #
@ -84,10 +85,10 @@ cfg_if::cfg_if! {
#[cfg(any(feature = "unstable", feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[inline]
pub fn blocking<F, R>(f: F) -> task::JoinHandle<R>
pub fn spawn_blocking<F, R>(f: F) -> task::JoinHandle<R>
where
F: FnOnce() -> R + Send + 'static,
R: Send + 'static,
{
blocking::spawn_blocking(future)
blocking::spawn(f)
}