Skip to content

Commit f45aeab

Browse files
committed
Link more docs in futures-util::compat
1 parent ea27ba3 commit f45aeab

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

futures-util/src/compat/compat.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
/// Converts a futures 0.3 `TryFuture`, `TryStream` or `Sink` into a futures 0.1
2-
/// `Future` and vice versa.
1+
/// Converts a futures 0.3 [`TryFuture`][futures_core::future::TryFuture],
2+
/// [`TryStream`][futures_core::stream::TryStream] or
3+
/// [`Sink`][futures_sink::Sink] into a futures 0.1 [`Future`][futures::Future],
4+
/// [`Stream`][futures::Stream] or [`Sink`][futures::Sink] and vice versa.
35
#[derive(Debug)]
46
#[must_use = "futures do nothing unless polled"]
57
pub struct Compat<T, Ex> {
@@ -13,7 +15,7 @@ impl<T, Ex> Compat<T, Ex> {
1315
self.inner
1416
}
1517

16-
/// Creates a new `Compat`.
18+
/// Creates a new [`Compat`].
1719
crate fn new(inner: T, executor: Option<Ex>) -> Compat<T, Ex> {
1820
Compat { inner, executor }
1921
}

futures-util/src/compat/executor.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ use futures_core::task::Executor as Executor03;
66
use futures_core::task as task03;
77
use futures_core::future::FutureObj;
88

9-
/// A future that can run on a futures 0.1 executor.
9+
/// A future that can run on a futures 0.1
10+
/// [`Executor`][futures::future::Executor].
1011
pub type Executor01Future = Compat<UnitError<FutureObj<'static, ()>>, Box<dyn Executor03 + Send>>;
1112

12-
/// Extension trait for futures 0.1 Executors.
13+
/// Extension trait for futures 0.1 [`Executor`][futures::future::Executor].
1314
pub trait Executor01CompatExt: Executor01<Executor01Future> +
1415
Clone + Send + 'static
1516
{
16-
/// Creates an `Executor` compatable with futures 0.3.
17+
/// Converts a futures 0.1 [`Executor`][futures::future::Executor] into a
18+
/// futures 0.3 [`Executor`][futures_core::task::Executor].
1719
fn compat(self) -> Executor01As03<Self>
1820
where Self: Sized;
1921
}
@@ -28,7 +30,8 @@ where Ex: Executor01<Executor01Future> + Clone + Send + 'static
2830
}
2931
}
3032

31-
/// Converts a futures 0.1 `Executor` into a futures 0.3 `Executor`.
33+
/// Converts a futures 0.1 [`Executor`][futures::future::Executor] into a
34+
/// futures 0.3 [`Executor`][futures_core::task::Executor].
3235
#[derive(Clone)]
3336
pub struct Executor01As03<Ex> {
3437
executor01: Ex

futures-util/src/compat/future01ext.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ use futures::Future as Future01;
33

44
impl<Fut: Future01> Future01CompatExt for Fut {}
55

6-
/// Extension trait for futures 0.1 Futures.
6+
/// Extension trait for futures 0.1 [`Future`][futures::Future]
77
pub trait Future01CompatExt: Future01 {
8-
/// Converts a futures 0.1 `Future<Item = T, Error = E>` into a
9-
/// futures 0.3 `Future<Output = Result<T, E>>`.
8+
/// Converts a futures 0.1 [`Future<Item = T, Error = E>`][futures::Future]
9+
/// into a futures 0.3 [`Future<Output = Result<T,
10+
/// E>>`][futures_core::Future].
1011
fn compat(self) -> Compat<Self, ()> where Self: Sized {
1112
Compat {
1213
inner: self,

0 commit comments

Comments
 (0)