Struct futures::channel::mpsc::UnboundedReceiver

source · [−]

pub struct UnboundedReceiver<T> { /* private fields */ }

Expand description

The receiving end of an unbounded mpsc channel.

This value is created by the unbounded function.

Implementations

source

impl<T> UnboundedReceiver<T>

source

pub fn close(&mut self)

Closes the receiving half of a channel, without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

source

pub fn try_next(&mut self) -> Result<Option<T>, TryRecvError>

Tries to receive the next message without notifying a context if empty.

It is not recommended to call this function from inside of a future, only when you’ve otherwise arranged to be notified when the channel is no longer empty.

This function returns:

Ok(Some(t)) when message is fetched
Ok(None) when channel is closed and no messages left in the queue
Err(e) when there are no messages available, but channel is not yet closed

Trait Implementations

source

impl<T> Debug for UnboundedReceiver<T>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

source

impl<T> Drop for UnboundedReceiver<T>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<T> FusedStream for UnboundedReceiver<T>

source

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

source

impl<T> Stream for UnboundedReceiver<T>

type Item = T

Values yielded by the stream.

source

fn poll_next(
self: Pin<&mut UnboundedReceiver<T>>,
cx: &mut Context<'_>
) -> Poll<Option<T>>

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. Read more

source

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

source

impl<T> Unpin for UnboundedReceiver<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for UnboundedReceiver<T>

impl<T> Send for UnboundedReceiver<T>where
T: Send,

impl<T> Sync for UnboundedReceiver<T>where
T: Send,

impl<T> !UnwindSafe for UnboundedReceiver<T>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

source

fn next(&mut self) -> Next<'_, Self>ⓘNotable traits for Next<'_, St>`impl<St> Future for Next<'_, St>where St: Stream + Unpin + ?Sized, type Output = Option<<St as Stream>::Item>;`where
Self: Unpin,

Creates a future that resolves to the next item in the stream. Read more

source

fn into_future(self) -> StreamFuture<Self>ⓘNotable traits for StreamFuture<St>`impl<St> Future for StreamFuture<St>where St: Stream + Unpin, type Output = (Option<<St as Stream>::Item>, St);`where
Self: Unpin,

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. Read more

source

fn map<T, F>(self, f: F) -> Map<Self, F>where
F: FnMut(Self::Item) -> T,

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

source

fn enumerate(self) -> Enumerate<Self>

Creates a stream which gives the current iteration count as well as the next value. Read more

source

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

source

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = Option<T>>,

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

source

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future,

Computes from this stream’s items new items of a different type using an asynchronous closure. Read more

source

fn collect<C>(self) -> Collect<Self, C>ⓘNotable traits for Collect<St, C>`impl<St, C> Future for Collect<St, C>where St: Stream, C: Default + Extend<<St as Stream>::Item>, type Output = C;`where
C: Default + Extend<Self::Item>,

Transforms a stream into a collection, returning a future representing the result of that computation. Read more

source

fn unzip<A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB>ⓘNotable traits for Unzip<St, FromA, FromB>`impl<St, A, B, FromA, FromB> Future for Unzip<St, FromA, FromB>where St: Stream<Item = (A, B)>, FromA: Default + Extend<A>, FromB: Default + Extend, type Output = (FromA, FromB);`where
 FromA: Default + Extend<A>,
 FromB: Default + Extend,
 Self: Stream<Item = (A, B)>,

Converts a stream of pairs into a future, which resolves to pair of containers. Read more

source

fn concat(self) -> Concat<Self>ⓘNotable traits for Concat<St>`impl<St> Future for Concat<St>where St: Stream, <St as Stream>::Item: Extend<<<St as Stream>::Item as IntoIterator>::Item> + IntoIterator + Default, type Output = <St as Stream>::Item;`where
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

source

fn count(self) -> Count<Self>ⓘNotable traits for Count<St>`impl<St> Future for Count<St>where St: Stream, type Output = usize;`

Drives the stream to completion, counting the number of items. Read more

source

fn cycle(self) -> Cycle<Self>where
Self: Clone,

Repeats a stream endlessly. Read more

source

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F>ⓘNotable traits for Fold<St, Fut, T, F>`impl<St, Fut, T, F> Future for Fold<St, Fut, T, F>where St: Stream, F: FnMut(T, <St as Stream>::Item) -> Fut, Fut: Future<Output = T>, type Output = T;`where
 F: FnMut(T, Self::Item) -> Fut,
 Fut: Future<Output = T>,

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

source

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>ⓘNotable traits for Any<St, Fut, F>`impl<St, Fut, F> Future for Any<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;`where
 F: FnMut(Self::Item) -> Fut,
 Fut: Future<Output = bool>,

Execute predicate over asynchronous stream, and return true if any element in stream satisfied a predicate. Read more

source

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>ⓘNotable traits for All<St, Fut, F>`impl<St, Fut, F> Future for All<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;`where
 F: FnMut(Self::Item) -> Fut,
 Fut: Future<Output = bool>,

Execute predicate over asynchronous stream, and return true if all element in stream satisfied a predicate. Read more

source

fn flatten(self) -> Flatten<Self>where
Self::Item: Stream,

Flattens a stream of streams into just one continuous stream. Read more

source

fn flatten_unordered(
 self,
 limit: impl Into<Option<usize>>
) -> FlattenUnorderedWithFlowController<Self, ()>where
 Self::Item: Stream + Unpin,

Flattens a stream of streams into just one continuous stream. Polls inner streams produced by the base stream concurrently. Read more

source

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
F: FnMut(Self::Item) -> U,
U: Stream,

Maps a stream like StreamExt::map but flattens nested Streams. Read more

source

fn flat_map_unordered<U, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> FlatMapUnordered<Self, U, F>where
 U: Stream + Unpin,
 F: FnMut(Self::Item) -> U,

Maps a stream like StreamExt::map but flattens nested Streams and polls them concurrently, yielding items in any order, as they made available. Read more

source

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option>,

Combinator similar to StreamExt::fold that holds internal state and produces a new stream. Read more

source

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

source

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

source

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where
Fut: Future,

Take elements from this stream until the provided future resolves. Read more

source

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F>ⓘNotable traits for ForEach<St, Fut, F>`impl<St, Fut, F> Future for ForEach<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = ()>, type Output = ();`where
 F: FnMut(Self::Item) -> Fut,
 Fut: Future<Output = ()>,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

source

fn for_each_concurrent<Fut, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> ForEachConcurrent<Self, Fut, F>ⓘNotable traits for ForEachConcurrent<St, Fut, F>`impl<St, Fut, F> Future for ForEachConcurrent<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = ()>, type Output = ();`where
 F: FnMut(Self::Item) -> Fut,
 Fut: Future<Output = ()>,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

source

fn take(self, n: usize) -> Take<Self>

Creates a new stream of at most n items of the underlying stream. Read more

source

fn skip(self, n: usize) -> Skip<Self>

Creates a new stream which skips n items of the underlying stream. Read more

source

fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used to turn any Stream into a FusedStream. Read more

source

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it. Read more

source

fn catch_unwind(self) -> CatchUnwind<Self>where
Self: UnwindSafe,

Catches unwinding panics while polling the stream. Read more

source

fn boxed<'a>(
 self
) -> Pin<Box<dyn Stream<Item = Self::Item> + Send + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pinwhere P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`where
 Self: 'a + Send,

Wrap the stream in a Box, pinning it. Read more

source

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pinwhere P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`where
Self: 'a,

Wrap the stream in a Box, pinning it. Read more

source

fn buffered(self, n: usize) -> Buffered<Self>where
Self::Item: Future,

An adaptor for creating a buffered list of pending futures. Read more

source

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where
Self::Item: Future,

An adaptor for creating a buffered list of pending futures (unordered). Read more

source

fn zip<St>(self, other: St) -> Zip<Self, St>where
St: Stream,

An adapter for zipping two streams together. Read more

source

fn chain<St>(self, other: St) -> Chain<Self, St>where
St: Stream<Item = Self::Item>,

Adapter for chaining two streams. Read more

source

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method. Read more

source

fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector. Read more

source

fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>

An adaptor for chunking up ready items of the stream inside a vector. Read more

source

fn forward<S>(self, sink: S) -> Forward<Self, S>ⓘNotable traits for Forward<St, Si>`impl<St, Si> Future for Forward<St, Si>where Forward<St, Si, <St as TryStream>::Ok>: Future, St: TryStream, type Output = <Forward<St, Si, <St as TryStream>::Ok> as Future>::Output;`where
 S: Sink<Self::Ok, Error = Self::Error>,
 Self: TryStream,

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

source

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where
Self: Sink<Item>,

Splits this Stream + Sink object into separate Sink and Stream objects. Read more

source

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),

Do something with each item of this stream, afterwards passing it on. Read more

source

fn left_stream(self) -> Either<Self, B>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`where
B: Stream<Item = Self::Item>,

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

source

fn right_stream(self) -> Either<B, Self>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`where
B: Stream<Item = Self::Item>,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

source

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where
Self: Unpin,

A convenience method for calling Stream::poll_next on Unpin stream types. Read more

source

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>ⓘNotable traits for SelectNextSome<'_, St>`impl<St> Future for SelectNextSome<'_, St>where St: FusedStream + Unpin + ?Sized, type Output = <St as Stream>::Item;`where
Self: Unpin + FusedStream,

Returns a Future that resolves when the next item in this stream is ready. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T, E> TryStream for Swhere
S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more

source

impl<S> TryStreamExt for Swhere
S: TryStream + ?Sized,

source

fn err_into<E>(self) -> ErrInto<Self, E>where
Self::Error: Into<E>,

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

source

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnMut(Self::Ok) -> T,

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

source

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where
F: FnMut(Self::Error) -> E,

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

source

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

source

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where
F: FnMut(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

source

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where
F: FnMut(&Self::Ok),

Do something with the success value of this stream, afterwards passing it on. Read more

source

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnMut(&Self::Error),

Do something with the error value of this stream, afterwards passing it on. Read more

source

fn into_stream(self) -> IntoStream<Self>

Wraps a TryStream into a type that implements Stream Read more

source

fn try_next(&mut self) -> TryNext<'_, Self>ⓘNotable traits for TryNext<'_, St>`impl<St> Future for TryNext<'_, St>where St: TryStream + Unpin + ?Sized, type Output = Result<Option<<St as TryStream>::Ok>, <St as TryStream>::Error>;`where
Self: Unpin,

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

source

fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F>ⓘNotable traits for TryForEach<St, Fut, F>`impl<St, Fut, F> Future for TryForEach<St, Fut, F>where St: TryStream, F: FnMut(<St as TryStream>::Ok) -> Fut, Fut: TryFuture<Ok = (), Error = <St as TryStream>::Error>, type Output = Result<(), <St as TryStream>::Error>;`where
 F: FnMut(Self::Ok) -> Fut,
 Fut: TryFuture<Ok = (), Error = Self::Error>,

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

source

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

source

fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

Take elements on this stream while the provided asynchronous predicate resolves to true. Read more

source

fn try_for_each_concurrent<Fut, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> TryForEachConcurrent<Self, Fut, F>ⓘNotable traits for TryForEachConcurrent<St, Fut, F>`impl<St, Fut, F> Future for TryForEachConcurrent<St, Fut, F>where St: TryStream, F: FnMut(<St as TryStream>::Ok) -> Fut, Fut: Future<Output = Result<(), <St as TryStream>::Error>>, type Output = Result<(), <St as TryStream>::Error>;`where
 F: FnMut(Self::Ok) -> Fut,
 Fut: Future<Output = Result<(), Self::Error>>,

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

source

fn try_collect<C>(self) -> TryCollect<Self, C>ⓘNotable traits for TryCollect<St, C>`impl<St, C> Future for TryCollect<St, C>where St: TryStream, C: Default + Extend<<St as TryStream>::Ok>, type Output = Result<C, <St as TryStream>::Error>;`where
C: Default + Extend<Self::Ok>,

Attempt to transform a stream into a collection, returning a future representing the result of that computation. Read more

source

fn try_chunks(self, capacity: usize) -> TryChunks<Self>

An adaptor for chunking up successful items of the stream inside a vector. Read more

source

fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F>where
Fut: Future<Output = bool>,
F: FnMut(&Self::Ok) -> Fut,

Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more

source

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F>where
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
F: FnMut(Self::Ok) -> Fut,

Attempt to filter the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

source

fn try_flatten_unordered(
 self,
 limit: impl Into<Option<usize>>
) -> TryFlattenUnordered<Self>where
 Self::Ok: TryStream + Unpin,
 <Self::Ok as TryStream>::Error: From<Self::Error>,

Flattens a stream of streams into just one continuous stream. Produced streams will be polled concurrently and any errors will be passed through without looking at them. If the underlying base stream returns an error, it will be immediately propagated. Read more

source

fn try_flatten(self) -> TryFlatten<Self>where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,

Flattens a stream of streams into just one continuous stream. Read more

source

fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F>ⓘNotable traits for TryFold<St, Fut, T, F>`impl<St, Fut, T, F> Future for TryFold<St, Fut, T, F>where St: TryStream, F: FnMut(T, <St as TryStream>::Ok) -> Fut, Fut: TryFuture<Ok = T, Error = <St as TryStream>::Error>, type Output = Result<T, <St as TryStream>::Error>;`where
 F: FnMut(T, Self::Ok) -> Fut,
 Fut: TryFuture<Ok = T, Error = Self::Error>,

Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

source

fn try_concat(self) -> TryConcat<Self>ⓘNotable traits for TryConcat<St>`impl<St> Future for TryConcat<St>where St: TryStream, <St as TryStream>::Ok: Extend<<<St as TryStream>::Ok as IntoIterator>::Item> + IntoIterator + Default, type Output = Result<<St as TryStream>::Ok, <St as TryStream>::Error>;`where
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item> + IntoIterator + Default,

Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

source

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self>where
Self::Ok: TryFuture<Error = Self::Error>,

Attempt to execute several futures from a stream concurrently (unordered). Read more

source

fn try_buffered(self, n: usize) -> TryBuffered<Self>where
Self::Ok: TryFuture<Error = Self::Error>,

Attempt to execute several futures from a stream concurrently. Read more

source

fn try_poll_next_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Ok, Self::Error>>>where
 Self: Unpin,

A convenience method for calling TryStream::try_poll_next on Unpin stream types. Read more

source

fn into_async_read(self) -> IntoAsyncRead<Self>where
Self: TryStreamExt<Error = Error>,
Self::Ok: AsRef<[u8]>,

Adapter that converts this stream into an AsyncBufRead. Read more

Struct futures::channel::mpsc::UnboundedReceiver

Implementations

impl<T> UnboundedReceiver<T>

pub fn close(&mut self)

pub fn try_next(&mut self) -> Result<Option<T>, TryRecvError>

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

impl<T> Drop for UnboundedReceiver<T>

fn drop(&mut self)

impl<T> FusedStream for UnboundedReceiver<T>

fn is_terminated(&self) -> bool

impl<T> Stream for UnboundedReceiver<T>

type Item = T

fn poll_next( self: Pin<&mut UnboundedReceiver<T>>, cx: &mut Context<'_>) -> Poll<Option<T>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<T> Unpin for UnboundedReceiver<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for UnboundedReceiver<T>

impl<T> Send for UnboundedReceiver<T>where T: Send,

impl<T> Sync for UnboundedReceiver<T>where T: Send,

impl<T> !UnwindSafe for UnboundedReceiver<T>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> StreamExt for Twhere T: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self>ⓘNotable traits for Next<'_, St>impl<St> Future for Next<'_, St>where St: Stream + Unpin + ?Sized, type Output = Option<<St as Stream>::Item>;where Self: Unpin,

fn into_future(self) -> StreamFuture<Self>ⓘNotable traits for StreamFuture<St>impl<St> Future for StreamFuture<St>where St: Stream + Unpin, type Output = (Option<<St as Stream>::Item>, St);where Self: Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F>where F: FnMut(Self::Item) -> T,

fn enumerate(self) -> Enumerate<Self>

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = Option<T>>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where F: FnMut(Self::Item) -> Fut, Fut: Future,

fn collect<C>(self) -> Collect<Self, C>ⓘNotable traits for Collect<St, C>impl<St, C> Future for Collect<St, C>where St: Stream, C: Default + Extend<<St as Stream>::Item>, type Output = C;where C: Default + Extend<Self::Item>,

fn count(self) -> Count<Self>ⓘNotable traits for Count<St>impl<St> Future for Count<St>where St: Stream, type Output = usize;

fn cycle(self) -> Cycle<Self>where Self: Clone,

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>ⓘNotable traits for Any<St, Fut, F>impl<St, Fut, F> Future for Any<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = bool>,

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>ⓘNotable traits for All<St, Fut, F>impl<St, Fut, F> Future for All<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = bool>,

fn flatten(self) -> Flatten<Self>where Self::Item: Stream,

fn flatten_unordered( self, limit: impl Into<Option<usize>>) -> FlattenUnorderedWithFlowController<Self, ()>where Self::Item: Stream + Unpin,

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where F: FnMut(Self::Item) -> U, U: Stream,

fn flat_map_unordered<U, F>( self, limit: impl Into<Option<usize>>, f: F) -> FlatMapUnordered<Self, U, F>where U: Stream + Unpin, F: FnMut(Self::Item) -> U,

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where F: FnMut(&mut S, Self::Item) -> Fut, Fut: Future<Output = Option<B>>,

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F>where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F>where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where Fut: Future,

fn take(self, n: usize) -> Take<Self>

fn skip(self, n: usize) -> Skip<Self>

fn fuse(self) -> Fuse<Self>

fn by_ref(&mut self) -> &mut Self

fn catch_unwind(self) -> CatchUnwind<Self>where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Stream<Item = Self::Item> + Send + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P>where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;where Self: 'a + Send,

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P>where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;where Self: 'a,

fn buffered(self, n: usize) -> Buffered<Self>where Self::Item: Future,

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where Self::Item: Future,

fn zip<St>(self, other: St) -> Zip<Self, St>where St: Stream,

fn chain<St>(self, other: St) -> Chain<Self, St>where St: Stream<Item = Self::Item>,

fn peekable(self) -> Peekable<Self>

fn chunks(self, capacity: usize) -> Chunks<Self>

fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where Self: Sink<Item>,

fn inspect<F>(self, f: F) -> Inspect<Self, F>where F: FnMut(&Self::Item),

fn left_stream<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;where B: Stream<Item = Self::Item>,

fn right_stream<B>(self) -> Either<B, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;where B: Stream<Item = Self::Item>,

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where Self: Unpin,

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>ⓘNotable traits for SelectNextSome<'_, St>impl<St> Future for SelectNextSome<'_, St>where St: FusedStream + Unpin + ?Sized, type Output = <St as Stream>::Item;where Self: Unpin + FusedStream,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn poll_next(
self: Pin<&mut UnboundedReceiver<T>>,
cx: &mut Context<'_>
) -> Poll<Option<T>>

impl<T> Send for UnboundedReceiver<T>where
T: Send,

impl<T> Sync for UnboundedReceiver<T>where
T: Send,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self>ⓘNotable traits for Next<'_, St>`impl<St> Future for Next<'_, St>where St: Stream + Unpin + ?Sized, type Output = Option<<St as Stream>::Item>;`where
Self: Unpin,

fn into_future(self) -> StreamFuture<Self>ⓘNotable traits for StreamFuture<St>`impl<St> Future for StreamFuture<St>where St: Stream + Unpin, type Output = (Option<<St as Stream>::Item>, St);`where
Self: Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F>where
F: FnMut(Self::Item) -> T,

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = Option<T>>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future,

fn collect<C>(self) -> Collect<Self, C>ⓘNotable traits for Collect<St, C>`impl<St, C> Future for Collect<St, C>where St: Stream, C: Default + Extend<<St as Stream>::Item>, type Output = C;`where
C: Default + Extend<Self::Item>,

fn count(self) -> Count<Self>ⓘNotable traits for Count<St>`impl<St> Future for Count<St>where St: Stream, type Output = usize;`

fn cycle(self) -> Cycle<Self>where
Self: Clone,

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>ⓘNotable traits for Any<St, Fut, F>`impl<St, Fut, F> Future for Any<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;`where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>ⓘNotable traits for All<St, Fut, F>`impl<St, Fut, F> Future for All<St, Fut, F>where St: Stream, F: FnMut(<St as Stream>::Item) -> Fut, Fut: Future<Output = bool>, type Output = bool;`where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn flatten(self) -> Flatten<Self>where
Self::Item: Stream,

fn flatten_unordered(
self,
limit: impl Into<Option<usize>>
) -> FlattenUnorderedWithFlowController<Self, ()>where
Self::Item: Stream + Unpin,

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
F: FnMut(Self::Item) -> U,
U: Stream,

fn flat_map_unordered<U, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> FlatMapUnordered<Self, U, F>where
U: Stream + Unpin,
F: FnMut(Self::Item) -> U,

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option<B>>,

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where
Fut: Future,

fn catch_unwind(self) -> CatchUnwind<Self>where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Stream<Item = Self::Item> + Send + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P>where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`where
Self: 'a + Send,

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P>where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`where
Self: 'a,

fn buffered(self, n: usize) -> Buffered<Self>where
Self::Item: Future,

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where
Self::Item: Future,

fn zip<St>(self, other: St) -> Zip<Self, St>where
St: Stream,

fn chain<St>(self, other: St) -> Chain<Self, St>where
St: Stream<Item = Self::Item>,

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where
Self: Sink<Item>,

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),

fn left_stream<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`where
B: Stream<Item = Self::Item>,

fn right_stream<B>(self) -> Either<B, Self>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`where
B: Stream<Item = Self::Item>,

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where
Self: Unpin,

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>ⓘNotable traits for SelectNextSome<'_, St>`impl<St> Future for SelectNextSome<'_, St>where St: FusedStream + Unpin + ?Sized, type Output = <St as Stream>::Item;`where
Self: Unpin + FusedStream,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<S, T, E> TryStream for Swhere
S: Stream<Item = Result<T, E>> + ?Sized,

fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

impl<S> TryStreamExt for Swhere
S: TryStream + ?Sized,

fn err_into<E>(self) -> ErrInto<Self, E>where
Self::Error: Into<E>,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnMut(Self::Ok) -> T,

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where
F: FnMut(Self::Error) -> E,

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where
F: FnMut(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where
F: FnMut(&Self::Ok),

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnMut(&Self::Error),

fn try_next(&mut self) -> TryNext<'_, Self>ⓘNotable traits for TryNext<'_, St>`impl<St> Future for TryNext<'_, St>where St: TryStream + Unpin + ?Sized, type Output = Result<Option<<St as TryStream>::Ok>, <St as TryStream>::Error>;`where
Self: Unpin,

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

fn try_collect<C>(self) -> TryCollect<Self, C>ⓘNotable traits for TryCollect<St, C>`impl<St, C> Future for TryCollect<St, C>where St: TryStream, C: Default + Extend<<St as TryStream>::Ok>, type Output = Result<C, <St as TryStream>::Error>;`where
C: Default + Extend<Self::Ok>,

fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F>where
Fut: Future<Output = bool>,
F: FnMut(&Self::Ok) -> Fut,

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F>where
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
F: FnMut(Self::Ok) -> Fut,

fn try_flatten_unordered(
self,
limit: impl Into<Option<usize>>
) -> TryFlattenUnordered<Self>where
Self::Ok: TryStream + Unpin,
<Self::Ok as TryStream>::Error: From<Self::Error>,

fn try_flatten(self) -> TryFlatten<Self>where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self>where
Self::Ok: TryFuture<Error = Self::Error>,

fn try_buffered(self, n: usize) -> TryBuffered<Self>where
Self::Ok: TryFuture<Error = Self::Error>,

fn try_poll_next_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Ok, Self::Error>>>where
Self: Unpin,

fn into_async_read(self) -> IntoAsyncRead<Self>where
Self: TryStreamExt<Error = Error>,
Self::Ok: AsRef<[u8]>,