Skip to content

Commit 0ae6d1e

Browse files
authored
Use #[doc(no_inline)] on re-exports from core/std (#2324)
1 parent 4124111 commit 0ae6d1e

File tree

7 files changed

+21
-17
lines changed

7 files changed

+21
-17
lines changed

futures-core/src/future.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ use core::ops::DerefMut;
44
use core::pin::Pin;
55
use core::task::{Context, Poll};
66

7+
#[doc(no_inline)]
78
pub use core::future::Future;
89

910
/// An owned dynamically typed [`Future`] for use in cases where you can't

futures-core/src/task/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ mod poll;
66
#[doc(hidden)]
77
pub mod __internal;
88

9+
#[doc(no_inline)]
910
pub use core::task::{Context, Poll, Waker, RawWaker, RawWakerVTable};

futures-io/src/lib.rs

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,13 @@ mod if_std {
3333
// Re-export some types from `std::io` so that users don't have to deal
3434
// with conflicts when `use`ing `futures::io` and `std::io`.
3535
#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
36-
pub use io::{
37-
Error as Error,
38-
ErrorKind as ErrorKind,
39-
Result as Result,
40-
IoSlice as IoSlice,
41-
IoSliceMut as IoSliceMut,
42-
SeekFrom as SeekFrom,
43-
};
44-
36+
#[doc(no_inline)]
37+
pub use io::{Error, ErrorKind, Result, IoSlice, IoSliceMut, SeekFrom};
4538
#[cfg(feature = "read-initializer")]
4639
#[cfg_attr(docsrs, doc(cfg(feature = "read-initializer")))]
40+
#[doc(no_inline)]
4741
#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
48-
pub use io::Initializer as Initializer;
42+
pub use io::Initializer;
4943

5044
/// Read bytes asynchronously.
5145
///

futures-task/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,5 @@ pub use crate::noop_waker::noop_waker;
5151
#[cfg(feature = "std")]
5252
pub use crate::noop_waker::noop_waker_ref;
5353

54+
#[doc(no_inline)]
5455
pub use core::task::{Context, Poll, Waker, RawWaker, RawWakerVTable};

futures-util/src/future/mod.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@
99
//! from a closure that defines its return value, and [`ready`](ready()),
1010
//! which constructs a future with an immediate defined value.
1111
12+
#[doc(no_inline)]
13+
pub use core::future::Future;
14+
1215
#[cfg(feature = "alloc")]
1316
pub use futures_core::future::{BoxFuture, LocalBoxFuture};
14-
pub use futures_core::future::{FusedFuture, Future, TryFuture};
17+
pub use futures_core::future::{FusedFuture, TryFuture};
1518
pub use futures_task::{FutureObj, LocalFutureObj, UnsafeFutureObj};
1619

1720
// Extension traits and combinators

futures-util/src/io/mod.rs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,16 @@ use crate::future::assert_future;
2323
use crate::stream::assert_stream;
2424
use std::{ptr, pin::Pin};
2525

26-
pub use futures_io::{
27-
AsyncRead, AsyncWrite, AsyncSeek, AsyncBufRead, Error, ErrorKind,
28-
IoSlice, IoSliceMut, Result, SeekFrom,
29-
};
26+
// Re-export some types from `std::io` so that users don't have to deal
27+
// with conflicts when `use`ing `futures::io` and `std::io`.
28+
#[doc(no_inline)]
29+
pub use std::io::{Error, ErrorKind, IoSlice, IoSliceMut, Result, SeekFrom};
30+
#[doc(no_inline)]
3031
#[cfg(feature = "read-initializer")]
3132
#[cfg_attr(docsrs, doc(cfg(feature = "read-initializer")))]
32-
pub use futures_io::Initializer;
33+
pub use std::io::Initializer;
34+
35+
pub use futures_io::{AsyncRead, AsyncWrite, AsyncSeek, AsyncBufRead};
3336

3437
// used by `BufReader` and `BufWriter`
3538
// https://github.com/rust-lang/rust/blob/master/src/libstd/sys_common/io.rs#L1

futures-util/src/task/mod.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
//! The remaining types and traits in the module are used for implementing
1111
//! executors or dealing with synchronization issues around task wakeup.
1212
13-
pub use futures_core::task::{Context, Poll, Waker, RawWaker, RawWakerVTable};
13+
#[doc(no_inline)]
14+
pub use core::task::{Context, Poll, Waker, RawWaker, RawWakerVTable};
1415

1516
pub use futures_task::{
1617
Spawn, LocalSpawn, SpawnError,

0 commit comments

Comments
 (0)