From 9186582cea335da6d8a80cbf30fb6555b60c8c8e Mon Sep 17 00:00:00 2001 From: Zachary S Date: Sun, 8 Oct 2023 19:43:00 -0500 Subject: [PATCH] Add doclinks to `FuturesOrdered`'s docs. --- futures-util/src/stream/futures_ordered.rs | 44 +++++++++++----------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/futures-util/src/stream/futures_ordered.rs b/futures-util/src/stream/futures_ordered.rs index 2fe67be30..23d00ce6b 100644 --- a/futures-util/src/stream/futures_ordered.rs +++ b/futures-util/src/stream/futures_ordered.rs @@ -65,29 +65,29 @@ where /// /// Futures are pushed into this queue and their realized values are yielded in /// order. This structure is optimized to manage a large number of futures. -/// Futures managed by `FuturesOrdered` will only be polled when they generate +/// Futures managed by [`FuturesOrdered`] will only be polled when they generate /// notifications. This reduces the required amount of work needed to coordinate /// large numbers of futures. /// -/// When a `FuturesOrdered` is first created, it does not contain any futures. -/// Calling `poll_next` in this state will result in `Poll::Ready(None))` to be -/// returned. Futures are submitted to the queue using `push_back` (or `push_front`); however, the -/// future will **not** be polled at this point. `FuturesOrdered` will only -/// poll managed futures when `FuturesOrdered::poll_next` is called. As such, it -/// is important to call `poll_next` after pushing new futures. +/// When a [`FuturesOrdered`] is first created, it does not contain any futures. +/// Calling [`poll_next`](FuturesOrdered::poll_next) in this state will result in [`Poll::Ready(None)`](Poll::Ready) to be +/// returned. Futures are submitted to the queue using [`push_back`](FuturesOrdered::push_back) (or [`push_front`](FuturesOrdered::push_front)); however, the +/// future will **not** be polled at this point. [`FuturesOrdered`] will only +/// poll managed futures when [`FuturesOrdered::poll_next`] is called. As such, it +/// is important to call [`poll_next`](FuturesOrdered::poll_next) after pushing new futures. /// -/// If `FuturesOrdered::poll_next` returns `Poll::Ready(None)` this means that +/// If [`FuturesOrdered::poll_next`] returns [`Poll::Ready(None)`](Poll::Ready) this means that /// the queue is currently not managing any futures. A future may be submitted /// to the queue at a later time. At that point, a call to -/// `FuturesOrdered::poll_next` will either return the future's resolved value -/// **or** `Poll::Pending` if the future has not yet completed. When -/// multiple futures are submitted to the queue, `FuturesOrdered::poll_next` will -/// return `Poll::Pending` until the first future completes, even if +/// [`FuturesOrdered::poll_next`] will either return the future's resolved value +/// **or** [`Poll::Pending`] if the future has not yet completed. When +/// multiple futures are submitted to the queue, [`FuturesOrdered::poll_next`] will +/// return [`Poll::Pending`] until the first future completes, even if /// some of the later futures have already completed. /// -/// Note that you can create a ready-made `FuturesOrdered` via the +/// Note that you can create a ready-made [`FuturesOrdered`] via the /// [`collect`](Iterator::collect) method, or you can start with an empty queue -/// with the `FuturesOrdered::new` constructor. +/// with the [`FuturesOrdered::new`] constructor. /// /// This type is only available when the `std` or `alloc` feature of this /// library is activated, and it is activated by default. @@ -104,8 +104,8 @@ impl Unpin for FuturesOrdered {} impl FuturesOrdered { /// Constructs a new, empty `FuturesOrdered` /// - /// The returned `FuturesOrdered` does not contain any futures and, in this - /// state, `FuturesOrdered::poll_next` will return `Poll::Ready(None)`. + /// The returned [`FuturesOrdered`] does not contain any futures and, in this + /// state, [`FuturesOrdered::poll_next`] will return [`Poll::Ready(None)`](Poll::Ready). pub fn new() -> Self { Self { in_progress_queue: FuturesUnordered::new(), @@ -132,8 +132,8 @@ impl FuturesOrdered { /// Push a future into the queue. /// /// This function submits the given future to the internal set for managing. - /// This function will not call `poll` on the submitted future. The caller - /// must ensure that `FuturesOrdered::poll_next` is called in order to receive + /// This function will not call [`poll`](Future::poll) on the submitted future. The caller + /// must ensure that [`FuturesOrdered::poll_next`] is called in order to receive /// task notifications. #[deprecated(note = "use `push_back` instead")] pub fn push(&mut self, future: Fut) { @@ -143,8 +143,8 @@ impl FuturesOrdered { /// Pushes a future to the back of the queue. /// /// This function submits the given future to the internal set for managing. - /// This function will not call `poll` on the submitted future. The caller - /// must ensure that `FuturesOrdered::poll_next` is called in order to receive + /// This function will not call [`poll`](Future::poll) on the submitted future. The caller + /// must ensure that [`FuturesOrdered::poll_next`] is called in order to receive /// task notifications. pub fn push_back(&mut self, future: Fut) { let wrapped = OrderWrapper { data: future, index: self.next_incoming_index }; @@ -155,8 +155,8 @@ impl FuturesOrdered { /// Pushes a future to the front of the queue. /// /// This function submits the given future to the internal set for managing. - /// This function will not call `poll` on the submitted future. The caller - /// must ensure that `FuturesOrdered::poll_next` is called in order to receive + /// This function will not call [`poll`](Future::poll) on the submitted future. The caller + /// must ensure that [`FuturesOrdered::poll_next`] is called in order to receive /// task notifications. This future will be the next future to be returned /// complete. pub fn push_front(&mut self, future: Fut) {