Replace "combinator" with "function"/"method"

Author: taiki-e

futures-util/src/future/catch_unwind.rs

@@ -6,7 +6,7 @@ use std::pin::Pin;
 use std::panic::{catch_unwind, UnwindSafe, AssertUnwindSafe};
 use std::prelude::v1::*;
 
-/// Future for the [`catch_unwind`](super::FutureExt::catch_unwind) combinator.
+/// Future for the [`catch_unwind`](super::FutureExt::catch_unwind) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct CatchUnwind<Fut> where Fut: Future {

futures-util/src/future/disabled/select.rs

@@ -3,7 +3,7 @@ use futures_core::task;
 
 use either::Either;
 
-/// Future for the [`select`](super::FutureExt::select) combinator.
+/// Future for the [`select`](super::FutureExt::select) method.
 #[must_use = "futures do nothing unless polled"]
 #[derive(Debug)]
 pub struct Select<A, B> {

futures-util/src/future/disabled/select_all.rs

@@ -7,7 +7,7 @@ use std::prelude::v1::*;
 use futures_core::{Future, IntoFuture, Poll, Async};
 use futures_core::task;
 
-/// Future for the [`select_all`] combinator.
+/// Future for the [`select_all`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct SelectAll<A> where A: Future {

futures-util/src/future/disabled/select_ok.rs

@@ -7,7 +7,7 @@ use std::prelude::v1::*;
 use futures_core::{Future, IntoFuture, Poll, Async};
 use futures_core::task;
 
-/// Future for the [`select_ok`] combinator.
+/// Future for the [`select_ok`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct SelectOk<A> where A: Future {

futures-util/src/future/empty.rs

@@ -3,7 +3,7 @@ use core::pin::Pin;
 use futures_core::future::{Future, FusedFuture};
 use futures_core::task::{Waker, Poll};
 
-/// Future for the [`empty`] combinator.
+/// Future for the [`empty`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Empty<T> {

futures-util/src/future/flatten.rs

@@ -5,7 +5,7 @@ use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Future for the [`flatten`](super::FutureExt::flatten) combinator.
+/// Future for the [`flatten`](super::FutureExt::flatten) method.
 #[must_use = "futures do nothing unless polled"]
 pub struct Flatten<Fut>
     where Fut: Future,

futures-util/src/future/flatten_stream.rs

@@ -4,8 +4,7 @@ use futures_core::future::Future;
 use futures_core::stream::{FusedStream, Stream};
 use futures_core::task::{Waker, Poll};
 
-/// Stream for the [`flatten_stream`](super::FutureExt::flatten_stream)
-/// combinator.
+/// Stream for the [`flatten_stream`](super::FutureExt::flatten_stream) method.
 #[must_use = "streams do nothing unless polled"]
 pub struct FlattenStream<Fut: Future> {
     state: State<Fut>

futures-util/src/future/fuse.rs

@@ -3,7 +3,7 @@ use futures_core::future::{Future, FusedFuture};
 use futures_core::task::{Waker, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Future for the [`fuse`](super::FutureExt::fuse) combinator.
+/// Future for the [`fuse`](super::FutureExt::fuse) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Fuse<Fut: Future> {

futures-util/src/future/inspect.rs

@@ -3,7 +3,7 @@ use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Future for the [`inspect`](super::FutureExt::inspect) combinator.
+/// Future for the [`inspect`](super::FutureExt::inspect) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Inspect<Fut, F> where Fut: Future {

futures-util/src/future/into_stream.rs

@@ -4,7 +4,7 @@ use futures_core::stream::Stream;
 use futures_core::task::{Waker, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Stream for the [`into_stream`](super::FutureExt::into_stream) combinator.
+/// Stream for the [`into_stream`](super::FutureExt::into_stream) method.
 #[must_use = "futures do nothing unless polled"]
 #[derive(Debug)]
 pub struct IntoStream<Fut: Future> {

futures-util/src/future/join.rs

@@ -68,15 +68,15 @@ macro_rules! generate {
 }
 
 generate! {
-    /// Future for the [`join`](super::FutureExt::join) combinator.
+    /// Future for the [`join`](super::FutureExt::join) method.
     (Join, <Fut1, Fut2>),
 
-    /// Future for the [`join3`](super::FutureExt::join3) combinator.
+    /// Future for the [`join3`](super::FutureExt::join3) method.
     (Join3, <Fut1, Fut2, Fut3>),
 
-    /// Future for the [`join4`](super::FutureExt::join4) combinator.
+    /// Future for the [`join4`](super::FutureExt::join4) method.
     (Join4, <Fut1, Fut2, Fut3, Fut4>),
 
-    /// Future for the [`join5`](super::FutureExt::join5) combinator.
+    /// Future for the [`join5`](super::FutureExt::join5) method.
     (Join5, <Fut1, Fut2, Fut3, Fut4, Fut5>),
 }

futures-util/src/future/join_all.rs

@@ -55,7 +55,7 @@ fn iter_pin_mut<T>(slice: Pin<&mut [T]>) -> impl Iterator<Item = Pin<&mut T>> {
         .map(|t| unsafe { Pin::new_unchecked(t) })
 }
 
-/// Future for the [`join_all`] combinator.
+/// Future for the [`join_all`] function.
 #[must_use = "futures do nothing unless polled"]
 pub struct JoinAll<F>
 where

futures-util/src/future/lazy.rs

@@ -2,7 +2,7 @@ use core::pin::Pin;
 use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 
-/// Future for the [`lazy`] combinator.
+/// Future for the [`lazy`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Lazy<F> {

futures-util/src/future/map.rs

@@ -3,7 +3,7 @@ use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Future for the [`map`](super::FutureExt::map) combinator.
+/// Future for the [`map`](super::FutureExt::map) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Map<Fut, F> {

futures-util/src/future/poll_fn.rs

@@ -4,7 +4,7 @@ use core::pin::Pin;
 use futures_core::future::Future;
 use futures_core::task::{Waker, Poll};
 
-/// Future for the [`poll_fn`] combinator.
+/// Future for the [`poll_fn`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct PollFn<F> {

futures-util/src/future/ready.rs

@@ -2,7 +2,7 @@ use core::pin::Pin;
 use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 
-/// Future for the [`ready`](ready()) combinator.
+/// Future for the [`ready`](ready()) function.
 #[derive(Debug, Clone)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Ready<T>(Option<T>);

futures-util/src/future/shared.rs

@@ -9,7 +9,7 @@ use std::sync::atomic::AtomicUsize;
 use std::sync::atomic::Ordering::SeqCst;
 use std::sync::{Arc, Mutex};
 
-/// Future for the [`shared`](super::FutureExt::shared) combinator.
+/// Future for the [`shared`](super::FutureExt::shared) method.
 #[must_use = "futures do nothing unless polled"]
 pub struct Shared<Fut: Future> {
     inner: Option<Arc<Inner<Fut>>>,

futures-util/src/future/then.rs

@@ -4,7 +4,7 @@ use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Waker, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Future for the [`then`](super::FutureExt::then) combinator.
+/// Future for the [`then`](super::FutureExt::then) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Then<Fut1, Fut2, F> {

futures-util/src/io/close.rs

@@ -4,7 +4,7 @@ use futures_io::AsyncWrite;
 use std::io;
 use std::pin::Pin;
 
-/// Future for the [`close`](super::AsyncWriteExt::close) combinator.
+/// Future for the [`close`](super::AsyncWriteExt::close) method.
 #[derive(Debug)]
 pub struct Close<'a, W: ?Sized + Unpin> {
     writer: &'a mut W,

futures-util/src/io/copy_into.rs

@@ -5,7 +5,7 @@ use std::boxed::Box;
 use std::io;
 use std::pin::Pin;
 
-/// Future for the [`copy_into`](super::AsyncReadExt::copy_into) combinator.
+/// Future for the [`copy_into`](super::AsyncReadExt::copy_into) method.
 #[derive(Debug)]
 pub struct CopyInto<'a, R: ?Sized + Unpin, W: ?Sized + Unpin> {
     reader: &'a mut R,

futures-util/src/io/disabled/lines.rs

@@ -6,7 +6,7 @@ use {Poll, Stream};
 
 use io::AsyncRead;
 
-/// Future for the [`lines`] combinator.
+/// Future for the [`lines`] function.
 #[derive(Debug)]
 pub struct Lines<A> {
     io: A,

futures-util/src/io/disabled/read_until.rs

@@ -6,7 +6,7 @@ use {Poll, Future};
 
 use io::AsyncRead;
 
-/// Future for the [`read_until`] combinator.
+/// Future for the [`read_until`] function.
 #[derive(Debug)]
 pub struct ReadUntil<A> {
     state: State<A>,

futures-util/src/io/flush.rs

@@ -4,7 +4,7 @@ use futures_io::AsyncWrite;
 use std::io;
 use std::pin::Pin;
 
-/// Future for the [`flush`](super::AsyncWriteExt::flush) combinator.
+/// Future for the [`flush`](super::AsyncWriteExt::flush) method.
 #[derive(Debug)]
 pub struct Flush<'a, W: ?Sized + Unpin> {
     writer: &'a mut W,

futures-util/src/io/read.rs

@@ -4,7 +4,7 @@ use futures_core::task::{Waker, Poll};
 use std::io;
 use std::pin::Pin;
 
-/// Future for the [`read`](super::AsyncReadExt::read) combinator.
+/// Future for the [`read`](super::AsyncReadExt::read) method.
 #[derive(Debug)]
 pub struct Read<'a, R: ?Sized + Unpin> {
     reader: &'a mut R,

futures-util/src/io/read_exact.rs

@@ -5,7 +5,7 @@ use std::io;
 use std::mem;
 use std::pin::Pin;
 
-/// Future for the [`read_exact`](super::AsyncReadExt::read_exact) combinator.
+/// Future for the [`read_exact`](super::AsyncReadExt::read_exact) method.
 #[derive(Debug)]
 pub struct ReadExact<'a, R: ?Sized + Unpin> {
     reader: &'a mut R,

futures-util/src/io/read_to_end.rs

@@ -5,7 +5,7 @@ use std::io;
 use std::pin::Pin;
 use std::vec::Vec;
 
-/// Future for the [`read_to_end`](super::AsyncReadExt::read_to_end) combinator.
+/// Future for the [`read_to_end`](super::AsyncReadExt::read_to_end) method.
 #[derive(Debug)]
 pub struct ReadToEnd<'a, R: ?Sized + Unpin> {
     reader: &'a mut R,

futures-util/src/io/write_all.rs

@@ -5,7 +5,7 @@ use std::io;
 use std::mem;
 use std::pin::Pin;
 
-/// Future for the [`write_all`](super::AsyncWriteExt::write_all) combinator.
+/// Future for the [`write_all`](super::AsyncWriteExt::write_all) method.
 #[derive(Debug)]
 pub struct WriteAll<'a, W: ?Sized + Unpin> {
     writer: &'a mut W,

futures-util/src/sink/buffer.rs

@@ -5,7 +5,7 @@ use pin_utils::{unsafe_pinned, unsafe_unpinned};
 use core::pin::Pin;
 use alloc::collections::VecDeque;
 
-/// Sink for the [`buffer`](super::SinkExt::buffer) combinator.
+/// Sink for the [`buffer`](super::SinkExt::buffer) method.
 #[derive(Debug)]
 #[must_use = "sinks do nothing unless polled"]
 pub struct Buffer<Si: Sink<Item>, Item> {

futures-util/src/sink/close.rs

@@ -4,7 +4,7 @@ use futures_core::future::Future;
 use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 
-/// Future for the [`close`](super::SinkExt::close) combinator.
+/// Future for the [`close`](super::SinkExt::close) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Close<'a, Si: Sink<Item> + Unpin + ?Sized, Item> {

futures-util/src/sink/drain.rs

@@ -4,7 +4,7 @@ use core::pin::Pin;
 use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 
-/// Sink for the [`drain`] combinator.
+/// Sink for the [`drain`] function.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Drain<T> {

futures-util/src/sink/err_into.rs

@@ -5,7 +5,7 @@ use futures_core::task::{Waker, Poll};
 use futures_sink::{Sink};
 use pin_utils::unsafe_pinned;
 
-/// Sink for the [`sink_err_into`](super::SinkExt::sink_err_into) combinator.
+/// Sink for the [`sink_err_into`](super::SinkExt::sink_err_into) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct SinkErrInto<Si: Sink<Item>, Item, E> {

futures-util/src/sink/flush.rs

@@ -4,7 +4,7 @@ use futures_core::future::Future;
 use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 
-/// Future for the [`flush`](super::SinkExt::flush) combinator.
+/// Future for the [`flush`](super::SinkExt::flush) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Flush<'a, Si: Sink<Item> + Unpin + ?Sized, Item> {

futures-util/src/sink/map_err.rs

@@ -4,7 +4,7 @@ use futures_core::task::{Waker, Poll};
 use futures_sink::{Sink};
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Sink for the [`sink_map_err`](super::SinkExt::sink_map_err) combinator.
+/// Sink for the [`sink_map_err`](super::SinkExt::sink_map_err) method.
 #[derive(Debug)]
 #[must_use = "sinks do nothing unless polled"]
 pub struct SinkMapErr<Si, F> {

futures-util/src/sink/send.rs

@@ -3,7 +3,7 @@ use futures_core::future::Future;
 use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 
-/// Future for the [`send`](super::SinkExt::send) combinator.
+/// Future for the [`send`](super::SinkExt::send) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct Send<'a, Si: Sink<Item> + Unpin + ?Sized, Item> {

futures-util/src/sink/send_all.rs

@@ -5,7 +5,7 @@ use futures_core::stream::Stream;
 use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 
-/// Future for the [`send_all`](super::SinkExt::send_all) combinator.
+/// Future for the [`send_all`](super::SinkExt::send_all) method.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct SendAll<'a, Si, St>

futures-util/src/sink/with.rs

@@ -7,7 +7,7 @@ use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Sink for the [`with`](super::SinkExt::with) combinator.
+/// Sink for the [`with`](super::SinkExt::with) method.
 #[derive(Debug)]
 #[must_use = "sinks do nothing unless polled"]
 pub struct With<Si, Item, U, Fut, F>

futures-util/src/sink/with_flat_map.rs

@@ -5,7 +5,7 @@ use futures_core::task::{Waker, Poll};
 use futures_sink::Sink;
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Sink for the [`with_flat_map`](super::SinkExt::with_flat_map) combinator.
+/// Sink for the [`with_flat_map`](super::SinkExt::with_flat_map) method.
 #[derive(Debug)]
 #[must_use = "sinks do nothing unless polled"]
 pub struct WithFlatMap<Si, Item, U, St, F>

futures-util/src/stream/buffer_unordered.rs

@@ -8,7 +8,7 @@ use core::fmt;
 use core::pin::Pin;
 
 /// Stream for the [`buffer_unordered`](super::StreamExt::buffer_unordered)
-/// combinator.
+/// method.
 #[must_use = "streams do nothing unless polled"]
 pub struct BufferUnordered<St>
 where

futures-util/src/stream/buffered.rs

@@ -7,7 +7,7 @@ use pin_utils::{unsafe_pinned, unsafe_unpinned};
 use core::fmt;
 use core::pin::Pin;
 
-/// Stream for the [`buffered`](super::StreamExt::buffered) combinator.
+/// Stream for the [`buffered`](super::StreamExt::buffered) method.
 #[must_use = "streams do nothing unless polled"]
 pub struct Buffered<St: Stream>
 where

futures-util/src/stream/catch_unwind.rs

@@ -6,7 +6,7 @@ use std::pin::Pin;
 use std::panic::{catch_unwind, UnwindSafe, AssertUnwindSafe};
 use std::prelude::v1::*;
 
-/// Stream for the [`catch_unwind`](super::StreamExt::catch_unwind) combinator.
+/// Stream for the [`catch_unwind`](super::StreamExt::catch_unwind) method.
 #[derive(Debug)]
 #[must_use = "streams do nothing unless polled"]
 pub struct CatchUnwind<St: Stream> {

futures-util/src/stream/chain.rs

@@ -3,7 +3,7 @@ use futures_core::stream::{FusedStream, Stream};
 use futures_core::task::{Waker, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Stream for the [`chain`](super::StreamExt::chain) combinator.
+/// Stream for the [`chain`](super::StreamExt::chain) method.
 #[derive(Debug)]
 #[must_use = "streams do nothing unless polled"]
 pub struct Chain<St1, St2> {

futures-util/src/stream/chunks.rs

@@ -7,7 +7,7 @@ use core::mem;
 use core::pin::Pin;
 use alloc::prelude::v1::*;
 
-/// Stream for the [`chunks`](super::StreamExt::chunks) combinator.
+/// Stream for the [`chunks`](super::StreamExt::chunks) method.
 #[derive(Debug)]
 #[must_use = "streams do nothing unless polled"]
 pub struct Chunks<St: Stream> {

futures-util/src/stream/collect.rs

@@ -5,7 +5,7 @@ use futures_core::stream::{FusedStream, Stream};
 use futures_core::task::{Waker, Poll};
 use pin_utils::{unsafe_pinned, unsafe_unpinned};
 
-/// Future for the [`collect`](super::StreamExt::collect) combinator.
+/// Future for the [`collect`](super::StreamExt::collect) method.
 #[derive(Debug)]
 #[must_use = "streams do nothing unless polled"]
 pub struct Collect<St, C> {