# Struct futures_channel::oneshot::Receiver [−] [src]

    #[must_use = "futures do nothing unless you `.await` or poll them"]pub struct Receiver<T> { /* fields omitted */ }

A future for a value that will be provided by another asynchronous task.

This is created by the `channel` function.

## Implementations

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

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

Gracefully close this receiver, preventing any subsequent attempts to send to it.

Any `send` operation which happens after this method returns is guaranteed to fail. After calling this method, you can use `Receiver::poll` to determine whether a message had previously been sent.

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

Attempts to receive a message outside of the context of a task.

Does not schedule a task wakeup or have any other side effects.

A return value of `None` must be considered immediately stale (out of date) unless `close` has been called first.

Returns an error if the sender was dropped.

## Trait Implementations

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

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

Formats the value using the given formatter. Read more

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

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

Executes the destructor for this type. Read more

### `impl<T> FusedFuture for Receiver<T>` [src]

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

Returns `true` if the underlying future should no longer be polled.

### `impl<T> Future for Receiver<T>` [src]

#### `type Output = Result<T, Canceled>`

The type of value produced on completion.

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

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

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

## Auto Trait Implementations

### `impl<T> !RefUnwindSafe for Receiver<T>`

### `impl<T> Send for Receiver<T> where
T: Send,`

### `impl<T> Sync for Receiver<T> where
T: Send,`

### `impl<T> !UnwindSafe for Receiver<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<F> IntoFuture for F where
F: Future,` [src]

#### `type Output = <F as Future>::Output`

🔬 This is a nightly-only experimental API. (`into_future`)

The output that the future will produce on completion.

#### `type Future = F`

🔬 This is a nightly-only experimental API. (`into_future`)

Which kind of future are we turning this into?

#### `pub fn into_future(self) -> <F as IntoFuture>::Future` [src]

🔬 This is a nightly-only experimental API. (`into_future`)

Creates a future from a value.

### `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<F, T, E> TryFuture for F where
F: Future<Output = 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(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>` [src]

Poll this `TryFuture` as if it were a `Future`. Read more

### `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.