wiki/content/20201120111157-ready.md

date	id	title
2020-11-20	23599316-9c90-48cf-b77d-63b5ee1a8496	ready

Description

readcy¹ creates a future that is immediately ready with a value.

Futures created through this function are functionally similar to those created through async {}. The main difference is that futures created through this function are named and implement Unpin.

Declaration

pub fn ready<T>() -> Ready<T>

Notable traits

impl<T> Future for Ready<T>
    type Output = T;

Examples

use core::future;

let a = future::ready(1);
assert_eq!(a.await, 1);

Footnotes

---

1. https://doc.rust-lang.org/std/future/fn.pending.html ↩︎