# Struct futures_channel::mpsc::UnboundedReceiver [−] [src]

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

The receiving end of an unbounded mpsc channel.

This value is created by the `unbounded` function.

## Implementations

### `impl<T> UnboundedReceiver<T>` [src]

#### `pub fn close(&mut self)` [src]

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.

#### `pub fn try_next(&mut self) -> Result<Option<T>, TryRecvError>` [src]

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 will panic if called after `try_next` or `poll_next` has returned `None`.

## Trait Implementations

### `impl<T: Debug> Debug for UnboundedReceiver<T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T> Drop for UnboundedReceiver<T>` [src]

#### `fn drop(&mut self)` [src]

Executes the destructor for this type. Read more

### `impl<T> FusedStream for UnboundedReceiver<T>` [src]

#### `fn is_terminated(&self) -> bool` [src]

Returns `true` if the stream should no longer be polled.

### `impl<T> Stream for UnboundedReceiver<T>` [src]

#### `type Item = T`

Values yielded by the stream.

#### `fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T>>` [src]

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

#### `pub fn size_hint(&self) -> (usize, Option<usize>)` [src]

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

### `impl<T> Unpin for UnboundedReceiver<T>` [src]

## 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 T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.

### `impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,` [src]

#### `type Ok = T`

The type of successful values yielded by this future

#### `type Error = E`

The type of failures yielded by this future

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

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