Skip to content

Commit 87b85e2

Browse files
committed
Rename noop/panic waker and fix other compilation issue
1 parent 803097a commit 87b85e2

File tree

25 files changed

+65
-65
lines changed

25 files changed

+65
-65
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ matrix:
2525

2626
# When updating this, the reminder to update the minimum required version in README.md.
2727
- name: cargo test (minimum required version)
28-
rust: nightly-2019-01-11
28+
rust: nightly-2019-02-15
2929

3030
- name: cargo clippy
3131
rust: nightly

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Now, you can use futures-rs:
3939
use futures::future::Future; // Note: It's not `futures_preview`
4040
```
4141

42-
The current version of futures-rs requires Rust nightly 2019-01-11 or later.
42+
The current version of futures-rs requires Rust nightly 2019-02-15 or later.
4343

4444
### Feature `std`
4545

futures-channel/benches/sync_mpsc.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ use {
1111
sink::Sink,
1212
task::{Waker, Poll},
1313
},
14-
futures_test::task::noop_local_waker_ref,
14+
futures_test::task::noop_waker_ref,
1515
std::pin::Pin,
1616
};
1717

1818
/// Single producer, single consumer
1919
#[bench]
2020
fn unbounded_1_tx(b: &mut Bencher) {
21-
let waker = noop_local_waker_ref();
21+
let waker = noop_waker_ref();
2222
b.iter(|| {
2323
let (tx, mut rx) = mpsc::unbounded();
2424

@@ -40,7 +40,7 @@ fn unbounded_1_tx(b: &mut Bencher) {
4040
/// 100 producers, single consumer
4141
#[bench]
4242
fn unbounded_100_tx(b: &mut Bencher) {
43-
let waker = noop_local_waker_ref();
43+
let waker = noop_waker_ref();
4444
b.iter(|| {
4545
let (tx, mut rx) = mpsc::unbounded();
4646

@@ -61,7 +61,7 @@ fn unbounded_100_tx(b: &mut Bencher) {
6161

6262
#[bench]
6363
fn unbounded_uncontended(b: &mut Bencher) {
64-
let waker = noop_local_waker_ref();
64+
let waker = noop_waker_ref();
6565
b.iter(|| {
6666
let (tx, mut rx) = mpsc::unbounded();
6767

@@ -101,7 +101,7 @@ impl Stream for TestSender {
101101
/// Single producers, single consumer
102102
#[bench]
103103
fn bounded_1_tx(b: &mut Bencher) {
104-
let waker = noop_local_waker_ref();
104+
let waker = noop_waker_ref();
105105
b.iter(|| {
106106
let (tx, mut rx) = mpsc::channel(0);
107107

@@ -118,7 +118,7 @@ fn bounded_1_tx(b: &mut Bencher) {
118118
/// 100 producers, single consumer
119119
#[bench]
120120
fn bounded_100_tx(b: &mut Bencher) {
121-
let waker = noop_local_waker_ref();
121+
let waker = noop_waker_ref();
122122
b.iter(|| {
123123
// Each sender can send one item after specified capacity
124124
let (tx, mut rx) = mpsc::channel(0);

futures-channel/src/mpsc/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -649,12 +649,12 @@ impl<T> Sender<T> {
649649
/// - `Err(SendError)` if the receiver has been dropped.
650650
pub fn poll_ready(
651651
&mut self,
652-
lw: &LocalWaker
652+
waker: &Waker
653653
) -> Poll<Result<(), SendError>> {
654654
let inner = self.0.as_mut().ok_or(SendError {
655655
kind: SendErrorKind::Disconnected,
656656
})?;
657-
inner.poll_ready(lw)
657+
inner.poll_ready(waker)
658658
}
659659

660660
/// Returns whether this channel is closed without needing a context.

futures-channel/tests/mpsc.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use futures::future::{FutureExt, poll_fn};
66
use futures::stream::{Stream, StreamExt};
77
use futures::sink::{Sink, SinkExt};
88
use futures::task::Poll;
9-
use futures_test::task::noop_local_waker_ref;
9+
use futures_test::task::noop_waker_ref;
1010
use pin_utils::pin_mut;
1111
use std::sync::{Arc, Mutex};
1212
use std::sync::atomic::{AtomicUsize, Ordering};
@@ -304,7 +304,7 @@ fn stress_receiver_multi_task_bounded_hard() {
304304
} else {
305305
// Just poll
306306
let n = n.clone();
307-
match rx.poll_next_unpin(noop_local_waker_ref()) {
307+
match rx.poll_next_unpin(noop_waker_ref()) {
308308
Poll::Ready(Some(_)) => {
309309
n.fetch_add(1, Ordering::Relaxed);
310310
}

futures-executor/benches/thread_notify.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ fn thread_yield_multi_thread(b: &mut Bencher) {
8989
Poll::Ready(())
9090
} else {
9191
self.rem -= 1;
92-
self.tx.send(waker.clone().into_waker()).unwrap();
92+
self.tx.send(waker.clone()).unwrap();
9393
Poll::Pending
9494
}
9595
}

futures-executor/src/local_pool.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ fn run_executor<T, F: FnMut(&Waker) -> Poll<T>>(mut f: F) -> T {
6767
another executor");
6868

6969
CURRENT_THREAD_NOTIFY.with(|thread_notify| {
70-
let waker: WakerRef = waker_ref(thread_notify);
70+
let waker: WakerRef<'_> = waker_ref(thread_notify);
7171
loop {
7272
if let Poll::Ready(t) = f(&waker) {
7373
return t;

futures-select-macro/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ pub fn select(input: TokenStream) -> TokenStream {
235235
let await_and_select = if let Some(default_expr) = parsed.default {
236236
quote! {
237237
if let #futures_crate::task::Poll::Ready(x) =
238-
__poll_fn(#futures_crate::task::noop_local_waker_ref())
238+
__poll_fn(#futures_crate::task::noop_waker_ref())
239239
{
240240
match x { #branches }
241241
} else {

futures-test/src/assert.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ macro_rules! assert_stream_pending {
3030
let mut stream = &mut $stream;
3131
$crate::assert::assert_is_unpin_stream(stream);
3232
let stream = $crate::std_reexport::pin::Pin::new(stream);
33-
let lw = &$crate::task::noop_local_waker_ref();
33+
let lw = &$crate::task::noop_waker_ref();
3434
let poll = $crate::futures_core_reexport::stream::Stream::poll_next(
3535
stream, lw,
3636
);
@@ -67,7 +67,7 @@ macro_rules! assert_stream_next {
6767
let mut stream = &mut $stream;
6868
$crate::assert::assert_is_unpin_stream(stream);
6969
let stream = $crate::std_reexport::pin::Pin::new(stream);
70-
let lw = &$crate::task::noop_local_waker_ref();
70+
let lw = &$crate::task::noop_waker_ref();
7171
match $crate::futures_core_reexport::stream::Stream::poll_next(stream, lw) {
7272
$crate::futures_core_reexport::task::Poll::Ready(Some(x)) => {
7373
assert_eq!(x, $item);
@@ -110,7 +110,7 @@ macro_rules! assert_stream_done {
110110
let mut stream = &mut $stream;
111111
$crate::assert::assert_is_unpin_stream(stream);
112112
let stream = $crate::std_reexport::pin::Pin::new(stream);
113-
let lw = &$crate::task::noop_local_waker_ref();
113+
let lw = &$crate::task::noop_waker_ref();
114114
match $crate::futures_core_reexport::stream::Stream::poll_next(stream, lw) {
115115
$crate::futures_core_reexport::task::Poll::Ready(Some(_)) => {
116116
panic!("assertion failed: expected stream to be done but had more elements");

futures-test/src/future/assert_unmoved.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ mod tests {
6464
use futures_core::future::Future;
6565
use futures_core::task::Poll;
6666
use futures_util::future::empty;
67-
use futures_util::task::noop_local_waker;
67+
use futures_util::task::noop_waker;
6868
use std::pin::Pin;
6969

7070
use super::AssertUnmoved;
@@ -80,7 +80,7 @@ mod tests {
8080
#[should_panic(expected = "Future moved between poll calls")]
8181
fn dont_double_panic() {
8282
// This test should only panic, not abort the process.
83-
let waker = noop_local_waker();
83+
let waker = noop_waker();
8484

8585
// First we allocate the future on the stack and poll it.
8686
let mut future = AssertUnmoved::new(empty::<()>());

futures-test/src/future/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pub trait FutureTestExt: Future {
4343
/// let future = (async { 5 }).pending_once();
4444
/// pin_mut!(future);
4545
///
46-
/// let lw = &task::noop_local_waker_ref();
46+
/// let lw = &task::noop_waker_ref();
4747
///
4848
/// assert_eq!(future.poll_unpin(lw), Poll::Pending);
4949
/// assert_eq!(future.poll_unpin(lw), Poll::Ready(5));

futures-test/src/task/mod.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
//! [`Spawn`](futures_core::task::Spawn) implementations.
66
//!
77
//! Test wakers:
8-
//! - [`noop_local_waker`] creates a waker that ignores calls to
8+
//! - [`noop_waker`] creates a waker that ignores calls to
99
//! [`wake`](futures_core::task::Waker).
10-
//! - [`panic_local_waker`] creates a waker that panics when
10+
//! - [`panic_waker`] creates a waker that panics when
1111
//! [`wake`](futures_core::task::Waker) is called.
1212
//! - [`new_count_waker`] creates a waker that increments a counter whenever
1313
//! [`wake`](futures_core::task::Waker) is called.
@@ -20,19 +20,19 @@
2020
//! - [`RecordSpawner`] records the spawned futures.
2121
//!
2222
//! For convenience there additionally exist various functions that directly
23-
//! return waker/spawner references: [`noop_local_waker_ref`],
24-
//! [`panic_local_waker_ref`], [`noop_spawner_mut`] and [`panic_spawner_mut`].
23+
//! return waker/spawner references: [`noop_waker_ref`],
24+
//! [`panic_waker_ref`], [`noop_spawner_mut`] and [`panic_spawner_mut`].
2525
2626
mod noop_spawner;
2727
pub use self::noop_spawner::{noop_spawner_mut, NoopSpawner};
2828

29-
pub use futures_util::task::{noop_local_waker, noop_local_waker_ref};
29+
pub use futures_util::task::{noop_waker, noop_waker_ref};
3030

3131
mod panic_spawner;
3232
pub use self::panic_spawner::{panic_spawner_mut, PanicSpawner};
3333

3434
mod panic_waker;
35-
pub use self::panic_waker::{panic_local_waker, panic_local_waker_ref};
35+
pub use self::panic_waker::{panic_waker, panic_waker_ref};
3636

3737
mod record_spawner;
3838
pub use self::record_spawner::RecordSpawner;

futures-test/src/task/panic_waker.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ fn raw_panic_waker() -> RawWaker {
3131
///
3232
/// ```should_panic
3333
/// #![feature(futures_api)]
34-
/// use futures_test::task::panic_local_waker;
34+
/// use futures_test::task::panic_waker;
3535
///
36-
/// let lw = panic_local_waker();
36+
/// let lw = panic_waker();
3737
/// lw.wake(); // Will panic
3838
/// ```
39-
pub fn panic_local_waker() -> Waker {
39+
pub fn panic_waker() -> Waker {
4040
unsafe { Waker::new_unchecked(raw_panic_waker()) }
4141
}
4242

@@ -49,15 +49,15 @@ pub fn panic_local_waker() -> Waker {
4949
/// ```should_panic
5050
/// #![feature(async_await, futures_api)]
5151
/// use futures::task;
52-
/// use futures_test::task::panic_local_waker_ref;
52+
/// use futures_test::task::panic_waker_ref;
5353
///
54-
/// let lw = panic_local_waker_ref();
54+
/// let lw = panic_waker_ref();
5555
/// lw.wake(); // Will panic
5656
/// ```
57-
pub fn panic_local_waker_ref() -> &'static Waker {
57+
pub fn panic_waker_ref() -> &'static Waker {
5858
thread_local! {
5959
static PANIC_WAKER_INSTANCE: UnsafeCell<Waker> =
60-
UnsafeCell::new(panic_local_waker());
60+
UnsafeCell::new(panic_waker());
6161
}
6262
PANIC_WAKER_INSTANCE.with(|l| unsafe { &*l.get() })
6363
}

futures-util/src/compat/compat01as03.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ impl<T> Compat01As03<T> {
2929
}
3030

3131
fn in_notify<R>(&mut self, waker: &Waker, f: impl FnOnce(&mut T) -> R) -> R {
32-
let notify = &WakerToHandle(waker.as_waker());
32+
let notify = &WakerToHandle(waker);
3333
self.inner.poll_fn_notify(notify, 0, f)
3434
}
3535
}

futures-util/src/compat/compat03as01.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ use futures_core::{
77
task as task03, TryFuture as TryFuture03, TryStream as TryStream03,
88
};
99
use futures_sink::Sink as Sink03;
10-
use futures_util::task::ArcWake as ArcWake03;
11-
use std::{marker::PhantomData, ops::Deref, pin::Pin, ptr::NonNull, sync::Arc};
10+
use crate::task::ArcWake as ArcWake03;
11+
use std::{pin::Pin, sync::Arc};
1212

1313
/// Converts a futures 0.3 [`TryFuture`](futures_core::future::TryFuture),
1414
/// [`TryStream`](futures_core::stream::TryStream) or
@@ -115,9 +115,9 @@ impl Current {
115115
Current(task01::current())
116116
}
117117

118-
fn as_waker(&self) -> Waker {
118+
fn as_waker(&self) -> task03::Waker {
119119
// For simplicity reasons wrap the Waker into an Arc.
120-
// We can optmize this again later on and reintroduce WakerLt<'a> which
120+
// We can optimize this again later on and reintroduce WakerLt<'a> which
121121
// derefs to Waker, and where cloning it through RawWakerVTable returns
122122
// an Arc version
123123
ArcWake03::into_waker(Arc::new(Current(self.0.clone())))

futures-util/src/task/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ mod arc_wake;
66
pub use self::arc_wake::ArcWake;
77

88
mod noop_waker;
9-
pub use self::noop_waker::{noop_local_waker, noop_local_waker_ref};
9+
pub use self::noop_waker::{noop_waker, noop_waker_ref};
1010

1111
mod spawn;
1212
pub use self::spawn::{SpawnExt, LocalSpawnExt};

futures-util/src/task/noop_waker.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ fn noop_raw_waker() -> RawWaker {
2828
///
2929
/// ```
3030
/// #![feature(futures_api)]
31-
/// use futures::task::noop_local_waker;
32-
/// let lw = noop_local_waker();
31+
/// use futures::task::noop_waker;
32+
/// let lw = noop_waker();
3333
/// lw.wake();
3434
/// ```
3535
#[inline]
36-
pub fn noop_local_waker() -> Waker {
36+
pub fn noop_waker() -> Waker {
3737
unsafe {
3838
Waker::new_unchecked(noop_raw_waker())
3939
}
@@ -47,15 +47,15 @@ pub fn noop_local_waker() -> Waker {
4747
///
4848
/// ```
4949
/// #![feature(futures_api)]
50-
/// use futures::task::noop_local_waker_ref;
51-
/// let lw = noop_local_waker_ref();
50+
/// use futures::task::noop_waker_ref;
51+
/// let lw = noop_waker_ref();
5252
/// lw.wake();
5353
/// ```
5454
#[inline]
55-
pub fn noop_local_waker_ref() -> &'static Waker {
55+
pub fn noop_waker_ref() -> &'static Waker {
5656
thread_local! {
5757
static NOOP_WAKER_INSTANCE: UnsafeCell<Waker> =
58-
UnsafeCell::new(noop_local_waker());
58+
UnsafeCell::new(noop_waker());
5959
}
6060
NOOP_WAKER_INSTANCE.with(|l| unsafe { &*l.get() })
6161
}

futures-util/src/try_stream/into_async_read.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ mod tests {
103103
use super::*;
104104
use futures::stream::{self, StreamExt, TryStreamExt};
105105
use futures_io::AsyncRead;
106-
use futures_test::task::noop_local_waker_ref;
106+
use futures_test::task::noop_waker_ref;
107107

108108
macro_rules! assert_read {
109109
($reader:expr, $buf:expr, $item:expr) => {
110-
let waker = noop_local_waker_ref();
110+
let waker = noop_waker_ref();
111111
match $reader.poll_read(waker, $buf) {
112112
Poll::Ready(Ok(x)) => {
113113
assert_eq!(x, $item);

futures-util/tests/futures_unordered.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
use futures::future;
44
use futures::task::Poll;
55
use futures::stream::{FusedStream, FuturesUnordered, StreamExt};
6-
use futures_test::task::noop_local_waker_ref;
6+
use futures_test::task::noop_waker_ref;
77

88
#[test]
99
fn is_terminated() {
10-
let lw = noop_local_waker_ref();
10+
let lw = noop_waker_ref();
1111
let mut tasks = FuturesUnordered::new();
1212

1313
assert_eq!(tasks.is_terminated(), false);

futures-util/tests/mutex.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ use futures::lock::Mutex;
66
use futures::stream::StreamExt;
77
use futures::task::SpawnExt;
88
use futures_test::future::FutureTestExt;
9-
use futures_test::task::{panic_local_waker_ref, new_count_waker};
9+
use futures_test::task::{panic_waker_ref, new_count_waker};
1010
use std::sync::Arc;
1111

1212
#[test]
1313
fn mutex_acquire_uncontested() {
1414
let mutex = Mutex::new(());
1515
for _ in 0..10 {
16-
assert!(mutex.lock().poll_unpin(panic_local_waker_ref()).is_ready());
16+
assert!(mutex.lock().poll_unpin(panic_waker_ref()).is_ready());
1717
}
1818
}
1919

2020
#[test]
2121
fn mutex_wakes_waiters() {
2222
let mutex = Mutex::new(());
2323
let (lw, counter) = new_count_waker();
24-
let lock = mutex.lock().poll_unpin(panic_local_waker_ref());
24+
let lock = mutex.lock().poll_unpin(panic_waker_ref());
2525
assert!(lock.is_ready());
2626

2727
let mut waiter = mutex.lock();
@@ -31,7 +31,7 @@ fn mutex_wakes_waiters() {
3131
drop(lock);
3232

3333
assert_eq!(counter, 1);
34-
assert!(waiter.poll_unpin(panic_local_waker_ref()).is_ready());
34+
assert!(waiter.poll_unpin(panic_waker_ref()).is_ready());
3535
}
3636

3737
#[test]

0 commit comments

Comments
 (0)