Trait holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::Stream
pub trait Stream {
type Item;
// Required method
fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>;
// Provided method
fn size_hint(&self) -> (usize, Option<usize>) { ... }
}
Expand description
A stream of values produced asynchronously.
If Future<Output = T>
is an asynchronous version of T
, then Stream<Item = T>
is an asynchronous version of Iterator<Item = T>
. A stream
represents a sequence of value-producing events that occur asynchronously to
the caller.
The trait is modeled after Future
, but allows poll_next
to be called
even after a value has been produced, yielding None
once the stream has
been fully exhausted.
Required Associated Types§
type Item
type Item
Values yielded by the stream.
Required Methods§
fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>
Attempt to pull out the next value of this stream, registering the
current task for wakeup if the value is not yet available, and returning
None
if the stream is exhausted.
Return value
There are several possible return values, each indicating a distinct stream state:
-
Poll::Pending
means that this stream’s next value is not ready yet. Implementations will ensure that the current task will be notified when the next value may be ready. -
Poll::Ready(Some(val))
means that the stream has successfully produced a value,val
, and may produce further values on subsequentpoll_next
calls. -
Poll::Ready(None)
means that the stream has terminated, andpoll_next
should not be invoked again.
Panics
Once a stream has finished (returned Ready(None)
from poll_next
), calling its
poll_next
method again may panic, block forever, or cause other kinds of
problems; the Stream
trait places no requirements on the effects of
such a call. However, as the poll_next
method is not marked unsafe
,
Rust’s usual rules apply: calls must never cause undefined behavior
(memory corruption, incorrect use of unsafe
functions, or the like),
regardless of the stream’s state.
If this is difficult to guard against then the fuse
adapter can be used
to ensure that poll_next
always returns Ready(None)
in subsequent
calls.
Provided Methods§
fn size_hint(&self) -> (usize, Option<usize>)
fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the stream.
Specifically, size_hint()
returns a tuple where the first element
is the lower bound, and the second element is the upper bound.
The second half of the tuple that is returned is an Option
<
usize
>
.
A None
here means that either there is no known upper bound, or the
upper bound is larger than usize
.
Implementation notes
It is not enforced that a stream implementation yields the declared number of elements. A buggy stream may yield less than the lower bound or more than the upper bound of elements.
size_hint()
is primarily intended to be used for optimizations such as
reserving space for the elements of the stream, but must not be
trusted to e.g., omit bounds checks in unsafe code. An incorrect
implementation of size_hint()
should not lead to memory safety
violations.
That said, the implementation should provide a correct estimation, because otherwise it would be a violation of the trait’s protocol.
The default implementation returns (0,
None
)
which is correct for any
stream.
Implementations on Foreign Types§
source§impl Stream for WebsocketListener
impl Stream for WebsocketListener
type Item = Result<(WebsocketSender, WebsocketReceiver), WebsocketError>
fn poll_next( self: Pin<&mut WebsocketListener>, cx: &mut Context<'_> ) -> Poll<Option<<WebsocketListener as Stream>::Item>>
source§impl Stream for WebsocketReceiver
impl Stream for WebsocketReceiver
type Item = (SerializedBytes, Respond)
fn poll_next( self: Pin<&mut WebsocketReceiver>, cx: &mut Context<'_> ) -> Poll<Option<<WebsocketReceiver as Stream>::Item>>
source§impl Stream for IntervalStream
impl Stream for IntervalStream
source§impl Stream for TcpListenerStream
impl Stream for TcpListenerStream
source§impl Stream for UnixListenerStream
impl Stream for UnixListenerStream
§impl Stream for Body
impl Stream for Body
Optional
This function requires enabling the stream
feature in your
Cargo.toml
.
§impl Stream for PollSemaphore
impl Stream for PollSemaphore
type Item = OwnedSemaphorePermit
fn poll_next( self: Pin<&mut PollSemaphore>, cx: &mut Context<'_> ) -> Poll<Option<OwnedSemaphorePermit>>
§impl<'a, Item, S, D, C> Stream for RatelimitedSink<'a, Item, S, D, C>
impl<'a, Item, S, D, C> Stream for RatelimitedSink<'a, Item, S, D, C>
Pass-through implementation for futures::Stream
if the Sink also implements it.
§impl<'a, S, D, C> Stream for RatelimitedStream<'a, S, D, C>
impl<'a, S, D, C> Stream for RatelimitedStream<'a, S, D, C>
Implements the futures::Stream
combinator.
§impl<R> Stream for Lines<R>where
R: AsyncBufRead,
impl<R> Stream for Lines<R>where
R: AsyncBufRead,
§impl<R> Stream for Lines<R>where
R: AsyncBufRead,
impl<R> Stream for Lines<R>where
R: AsyncBufRead,
§impl<R> Stream for Lines<R>where
R: AsyncBufRead,
impl<R> Stream for Lines<R>where
R: AsyncBufRead,
§impl<R> Stream for Split<R>where
R: AsyncBufRead,
impl<R> Stream for Split<R>where
R: AsyncBufRead,
§impl<R> Stream for Split<R>where
R: AsyncBufRead,
impl<R> Stream for Split<R>where
R: AsyncBufRead,
§impl<R> Stream for Split<R>where
R: AsyncBufRead,
impl<R> Stream for Split<R>where
R: AsyncBufRead,
§impl<S> Stream for AssertUnwindSafe<S>where
S: Stream,
impl<S> Stream for AssertUnwindSafe<S>where
S: Stream,
source§impl<S> Stream for StreamNotifyClose<S>where
S: Stream,
impl<S> Stream for StreamNotifyClose<S>where
S: Stream,
source§impl<T> Stream for WithContext<T>where
T: Stream,
impl<T> Stream for WithContext<T>where
T: Stream,
source§impl<T> Stream for BroadcastStream<T>
impl<T> Stream for BroadcastStream<T>
type Item = Result<T, BroadcastStreamRecvError>
fn poll_next( self: Pin<&mut BroadcastStream<T>>, cx: &mut Context<'_> ) -> Poll<Option<<BroadcastStream<T> as Stream>::Item>>
source§impl<T> Stream for ReceiverStream<T>
impl<T> Stream for ReceiverStream<T>
source§impl<T> Stream for UnboundedReceiverStream<T>
impl<T> Stream for UnboundedReceiverStream<T>
source§impl<T> Stream for WatchStream<T>
impl<T> Stream for WatchStream<T>
source§impl<T, S> Stream for StopListenerFuse<T, S>
impl<T, S> Stream for StopListenerFuse<T, S>
Implementors§
§impl<A, B> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::Either<A, B>
impl<A, B> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::Either<A, B>
§impl<A, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::RepeatWith<F>where
F: FnMut() -> A,
impl<A, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::RepeatWith<F>where
F: FnMut() -> A,
§impl<B, St, S, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Scan<St, S, Fut, F>
impl<B, St, S, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Scan<St, S, Fut, F>
§impl<F> Stream for FlattenStream<F>
impl<F> Stream for FlattenStream<F>
§impl<F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::IntoStream<F>
impl<F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::IntoStream<F>
§impl<Fut> Stream for TryFlattenStream<Fut>
impl<Fut> Stream for TryFlattenStream<Fut>
§impl<Fut> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Once<Fut>where
Fut: Future,
impl<Fut> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Once<Fut>where
Fut: Future,
§impl<Fut, Si> Stream for FlattenSink<Fut, Si>where
TryFlatten<Fut, Si>: Stream,
impl<Fut, Si> Stream for FlattenSink<Fut, Si>where
TryFlatten<Fut, Si>: Stream,
§impl<I> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Iter<I>where
I: Iterator,
impl<I> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Iter<I>where
I: Iterator,
§impl<R> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::io::Lines<R>where
R: AsyncBufRead,
impl<R> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::io::Lines<R>where
R: AsyncBufRead,
§impl<S> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Fuse<S>where
S: Stream,
impl<S> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Fuse<S>where
S: Stream,
§impl<S, Item, E> Stream for SinkErrInto<S, Item, E>
impl<S, Item, E> Stream for SinkErrInto<S, Item, E>
§impl<S, Item, U, St, F> Stream for WithFlatMap<S, Item, U, St, F>
impl<S, Item, U, St, F> Stream for WithFlatMap<S, Item, U, St, F>
§impl<St1, St2> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Chain<St1, St2>
impl<St1, St2> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Chain<St1, St2>
§impl<St1, St2> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Zip<St1, St2>
impl<St1, St2> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Zip<St1, St2>
§impl<St1, St2, Clos, State> Stream for SelectWithStrategy<St1, St2, Clos, State>
impl<St1, St2, Clos, State> Stream for SelectWithStrategy<St1, St2, Clos, State>
§impl<St> Stream for BufferUnordered<St>
impl<St> Stream for BufferUnordered<St>
§impl<St> Stream for CatchUnwind<St>where
St: Stream + UnwindSafe,
impl<St> Stream for CatchUnwind<St>where
St: Stream + UnwindSafe,
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Cycle<St>
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Cycle<St>
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Enumerate<St>where
St: Stream,
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Enumerate<St>where
St: Stream,
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Flatten<St>
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Flatten<St>
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::IntoStream<St>where
St: TryStream,
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::IntoStream<St>where
St: TryStream,
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Skip<St>where
St: Stream,
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Skip<St>where
St: Stream,
§impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Take<St>where
St: Stream,
impl<St> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Take<St>where
St: Stream,
§impl<St> Stream for TryBufferUnordered<St>
impl<St> Stream for TryBufferUnordered<St>
§impl<St> Stream for TryBuffered<St>
impl<St> Stream for TryBuffered<St>
§impl<St> Stream for TryFlatten<St>
impl<St> Stream for TryFlatten<St>
§impl<St> Stream for TryFlattenUnordered<St>
impl<St> Stream for TryFlattenUnordered<St>
§impl<St> Stream for TryReadyChunks<St>where
St: TryStream,
impl<St> Stream for TryReadyChunks<St>where
St: TryStream,
§impl<St, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Inspect<St, F>
impl<St, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Inspect<St, F>
§impl<St, F> Stream for InspectErr<St, F>
impl<St, F> Stream for InspectErr<St, F>
§impl<St, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Map<St, F>
impl<St, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Map<St, F>
§impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Filter<St, Fut, F>
impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Filter<St, Fut, F>
§impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::SkipWhile<St, Fut, F>
impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::SkipWhile<St, Fut, F>
§impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::TakeWhile<St, Fut, F>
impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::TakeWhile<St, Fut, F>
§impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Then<St, Fut, F>
impl<St, Fut, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Then<St, Fut, F>
§impl<St, Fut, F> Stream for TrySkipWhile<St, Fut, F>
impl<St, Fut, F> Stream for TrySkipWhile<St, Fut, F>
§impl<St, Fut, F> Stream for TryTakeWhile<St, Fut, F>
impl<St, Fut, F> Stream for TryTakeWhile<St, Fut, F>
§impl<St, Fut, F, T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::FilterMap<St, Fut, F>
impl<St, Fut, F, T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::FilterMap<St, Fut, F>
§impl<St, Fut, F, T> Stream for TryFilterMap<St, Fut, F>
impl<St, Fut, F, T> Stream for TryFilterMap<St, Fut, F>
§impl<St, U, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::FlatMap<St, U, F>
impl<St, U, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::FlatMap<St, U, F>
§impl<St, U, F> Stream for FlatMapUnordered<St, U, F>
impl<St, U, F> Stream for FlatMapUnordered<St, U, F>
§impl<T> Stream for S3Receiver<T>where
T: for<'de> Deserialize<'de>,
impl<T> Stream for S3Receiver<T>where
T: for<'de> Deserialize<'de>,
§impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::channel::mpsc::Receiver<T>
impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::channel::mpsc::Receiver<T>
§impl<T> Stream for UnboundedReceiver<T>
impl<T> Stream for UnboundedReceiver<T>
§impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Empty<T>
impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Empty<T>
§impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Pending<T>
impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Pending<T>
§impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Repeat<T>where
T: Clone,
impl<T> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::stream::Repeat<T>where
T: Clone,
§impl<T, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::PollImmediate<F>where
F: Future<Output = T>,
impl<T, F> Stream for holochain::prelude::dependencies::kitsune_p2p_types::dependencies::futures::prelude::future::PollImmediate<F>where
F: Future<Output = T>,
A Stream implementation that can be polled repeatedly until the future is done. The stream will never return Poll::Pending so polling it in a tight loop is worse than using a blocking synchronous function.
use futures::task::Poll;
use futures::{StreamExt, future, pin_mut};
use future::FusedFuture;
let f = async { 1_u32 };
pin_mut!(f);
let mut r = future::poll_immediate(f);
assert_eq!(r.next().await, Some(Poll::Ready(1)));
let f = async {futures::pending!(); 42_u8};
pin_mut!(f);
let mut p = future::poll_immediate(f);
assert_eq!(p.next().await, Some(Poll::Pending));
assert!(!p.is_terminated());
assert_eq!(p.next().await, Some(Poll::Ready(42)));
assert!(p.is_terminated());
assert_eq!(p.next().await, None);