Skip to content

Commit 0165381

Browse files
committed
chore: replace all doctest usage of pin_mut with pin
Signed-off-by: tison <[email protected]>
1 parent 3ce1fca commit 0165381

File tree

6 files changed

+45
-33
lines changed

6 files changed

+45
-33
lines changed

futures-test/src/assert.rs

+18-15
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,16 @@ pub fn assert_is_unpin_stream<S: Stream + Unpin>(_: &mut S) {}
99
/// # Examples
1010
///
1111
/// ```
12+
/// use core::pin::pin;
13+
///
1214
/// use futures::stream;
1315
/// use futures_test::future::FutureTestExt;
14-
/// use futures_test::{
15-
/// assert_stream_pending, assert_stream_next, assert_stream_done,
16-
/// };
17-
/// use futures::pin_mut;
16+
/// use futures_test::assert_stream_pending;
17+
/// use futures_test::assert_stream_next;
18+
/// use futures_test::assert_stream_done;
1819
///
1920
/// let stream = stream::once((async { 5 }).pending_once());
20-
/// pin_mut!(stream);
21+
/// let mut stream = pin!(stream);
2122
///
2223
/// assert_stream_pending!(stream);
2324
/// assert_stream_next!(stream, 5);
@@ -46,15 +47,16 @@ macro_rules! assert_stream_pending {
4647
/// # Examples
4748
///
4849
/// ```
50+
/// use core::pin::pin;
51+
///
4952
/// use futures::stream;
5053
/// use futures_test::future::FutureTestExt;
51-
/// use futures_test::{
52-
/// assert_stream_pending, assert_stream_next, assert_stream_done,
53-
/// };
54-
/// use futures::pin_mut;
54+
/// use futures_test::assert_stream_pending;
55+
/// use futures_test::assert_stream_next;
56+
/// use futures_test::assert_stream_done;
5557
///
5658
/// let stream = stream::once((async { 5 }).pending_once());
57-
/// pin_mut!(stream);
59+
/// let mut stream = pin!(stream);
5860
///
5961
/// assert_stream_pending!(stream);
6062
/// assert_stream_next!(stream, 5);
@@ -90,15 +92,16 @@ macro_rules! assert_stream_next {
9092
/// # Examples
9193
///
9294
/// ```
95+
/// use core::pin::pin;
96+
///
9397
/// use futures::stream;
9498
/// use futures_test::future::FutureTestExt;
95-
/// use futures_test::{
96-
/// assert_stream_pending, assert_stream_next, assert_stream_done,
97-
/// };
98-
/// use futures::pin_mut;
99+
/// use futures_test::assert_stream_pending;
100+
/// use futures_test::assert_stream_next;
101+
/// use futures_test::assert_stream_done;
99102
///
100103
/// let stream = stream::once((async { 5 }).pending_once());
101-
/// pin_mut!(stream);
104+
/// let mut stream = pin!(stream);
102105
///
103106
/// assert_stream_pending!(stream);
104107
/// assert_stream_next!(stream, 5);

futures-test/src/future/mod.rs

+6-4
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,15 @@ pub trait FutureTestExt: Future {
3232
/// # Examples
3333
///
3434
/// ```
35+
/// use core::pin::pin;
36+
///
3537
/// use futures::task::Poll;
3638
/// use futures::future::FutureExt;
3739
/// use futures_test::task::noop_context;
3840
/// use futures_test::future::FutureTestExt;
39-
/// use futures::pin_mut;
4041
///
4142
/// let future = (async { 5 }).pending_once();
42-
/// pin_mut!(future);
43+
/// let mut future = pin!(future);
4344
///
4445
/// let mut cx = noop_context();
4546
///
@@ -84,14 +85,15 @@ pub trait FutureTestExt: Future {
8485
/// # Examples
8586
///
8687
/// ```
88+
/// use core::pin::pin;
89+
///
8790
/// use futures::task::Poll;
8891
/// use futures::future::{self, Future};
8992
/// use futures_test::task::noop_context;
9093
/// use futures_test::future::FutureTestExt;
91-
/// use futures::pin_mut;
9294
///
9395
/// let future = future::ready(1).interleave_pending();
94-
/// pin_mut!(future);
96+
/// let mut future = pin!(future);
9597
///
9698
/// let mut cx = noop_context();
9799
///

futures-test/src/io/read/mod.rs

+9-6
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,15 @@ pub trait AsyncReadTestExt: AsyncRead {
2929
/// # Examples
3030
///
3131
/// ```
32+
/// use core::pin::pin;
33+
///
3234
/// use futures::task::Poll;
3335
/// use futures::io::{AsyncRead, Cursor};
3436
/// use futures_test::task::noop_context;
3537
/// use futures_test::io::AsyncReadTestExt;
36-
/// use futures::pin_mut;
3738
///
3839
/// let reader = Cursor::new(&[1, 2, 3]).interleave_pending();
39-
/// pin_mut!(reader);
40+
/// let mut reader = pin!(reader);
4041
///
4142
/// let mut cx = noop_context();
4243
///
@@ -59,14 +60,15 @@ pub trait AsyncReadTestExt: AsyncRead {
5960
/// The returned reader will also implement `AsyncBufRead` if the underlying reader does.
6061
///
6162
/// ```
63+
/// use core::pin::pin;
64+
///
6265
/// use futures::task::Poll;
6366
/// use futures::io::{AsyncBufRead, Cursor};
6467
/// use futures_test::task::noop_context;
6568
/// use futures_test::io::AsyncReadTestExt;
66-
/// use futures::pin_mut;
6769
///
6870
/// let reader = Cursor::new(&[1, 2, 3]).interleave_pending();
69-
/// pin_mut!(reader);
71+
/// let mut reader = pin!(reader);
7072
///
7173
/// let mut cx = noop_context();
7274
///
@@ -93,14 +95,15 @@ pub trait AsyncReadTestExt: AsyncRead {
9395
/// # Examples
9496
///
9597
/// ```
98+
/// use core::pin::pin;
99+
///
96100
/// use futures::task::Poll;
97101
/// use futures::io::{AsyncRead, Cursor};
98102
/// use futures_test::task::noop_context;
99103
/// use futures_test::io::AsyncReadTestExt;
100-
/// use futures::pin_mut;
101104
///
102105
/// let reader = Cursor::new(&[1, 2, 3, 4, 5]).limited(2);
103-
/// pin_mut!(reader);
106+
/// let mut reader = pin!(reader);
104107
///
105108
/// let mut cx = noop_context();
106109
///

futures-test/src/io/write/mod.rs

+6-4
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,15 @@ pub trait AsyncWriteTestExt: AsyncWrite {
3030
/// # Examples
3131
///
3232
/// ```
33+
/// use core::pin::pin;
34+
///
3335
/// use futures::task::Poll;
3436
/// use futures::io::{AsyncWrite, Cursor};
3537
/// use futures_test::task::noop_context;
3638
/// use futures_test::io::AsyncWriteTestExt;
37-
/// use futures::pin_mut;
3839
///
3940
/// let writer = Cursor::new(vec![0u8; 4].into_boxed_slice()).interleave_pending_write();
40-
/// pin_mut!(writer);
41+
/// let mut writer = pin!(writer);
4142
///
4243
/// let mut cx = noop_context();
4344
///
@@ -70,14 +71,15 @@ pub trait AsyncWriteTestExt: AsyncWrite {
7071
/// # Examples
7172
///
7273
/// ```
74+
/// use core::pin::pin;
75+
///
7376
/// use futures::task::Poll;
7477
/// use futures::io::{AsyncWrite, Cursor};
7578
/// use futures_test::task::noop_context;
7679
/// use futures_test::io::AsyncWriteTestExt;
77-
/// use futures::pin_mut;
7880
///
7981
/// let writer = Cursor::new(vec![0u8; 4].into_boxed_slice()).limited_write(2);
80-
/// pin_mut!(writer);
82+
/// let mut writer = pin!(writer);
8183
///
8284
/// let mut cx = noop_context();
8385
///

futures-test/src/stream/mod.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ pub trait StreamTestExt: Stream {
2828
/// # Examples
2929
///
3030
/// ```
31+
/// use core::pin::pin;
32+
///
3133
/// use futures::task::Poll;
3234
/// use futures::stream::{self, Stream};
3335
/// use futures_test::task::noop_context;
3436
/// use futures_test::stream::StreamTestExt;
35-
/// use futures::pin_mut;
3637
///
3738
/// let stream = stream::iter(vec![1, 2]).interleave_pending();
38-
/// pin_mut!(stream);
39+
/// let mut stream = pin!(stream);
3940
///
4041
/// let mut cx = noop_context();
4142
///

futures-test/src/task/context.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ pub fn panic_context() -> Context<'static> {
2222
/// # Examples
2323
///
2424
/// ```
25+
/// use core::pin::pin;
26+
///
2527
/// use futures::future::Future;
2628
/// use futures::task::Poll;
2729
/// use futures_test::task::noop_context;
28-
/// use futures::pin_mut;
2930
///
3031
/// let future = async { 5 };
31-
/// pin_mut!(future);
32+
/// let mut future = pin!(future);
3233
///
3334
/// assert_eq!(future.poll(&mut noop_context()), Poll::Ready(5));
3435
/// ```

0 commit comments

Comments
 (0)