Enum std::task::Poll

#[must_use = "this `Poll` may be a `Pending` variant, which should be handled"]
pub enum Poll<T> {
    Ready(T),
    Pending,
}

指示值是否可用，或者当前任务是否已安排为接收唤醒。

Variants

Ready(T)

表示立即准备好值。

Pending

表示尚未准备好值。

当一个函数返回 Pending 时，该函数 必须 还必须确保计划在进度完成时唤醒当前任务。

Implementations

impl<T> Poll<T>

pub fn map<U, F>(self, f: F) -> Poll<U> where
    F: FnOnce(T) -> U, 

通过将函数应用于包含的值，Maps 从 Poll<T> 到 Poll<U>。

Examples

将 Poll<String> 转换为 Poll<usize>，消耗原始值:

let poll_some_string = Poll::Ready(String::from("Hello, World!"));
// `Poll::map` 按值获取 self，消耗 `poll_some_string`
let poll_some_len = poll_some_string.map(|s| s.len());

assert_eq!(poll_some_len, Poll::Ready(13));

pub const fn is_ready(&self) -> bool

如果轮询是 Poll::Ready 值，则返回 true。

Examples

let x: Poll<u32> = Poll::Ready(2);
assert_eq!(x.is_ready(), true);

let x: Poll<u32> = Poll::Pending;
assert_eq!(x.is_ready(), false);

pub const fn is_pending(&self) -> bool

如果轮询是 Pending 值，则返回 true。

Examples

let x: Poll<u32> = Poll::Ready(2);
assert_eq!(x.is_pending(), false);

let x: Poll<u32> = Poll::Pending;
assert_eq!(x.is_pending(), true);

impl<T, E> Poll<Result<T, E>>

pub fn map_ok<U, F>(self, f: F) -> Poll<Result<U, E>> where
    F: FnOnce(T) -> U, 

通过对包含的 Poll::Ready(Ok) 值应用函数，Maps 将 Poll<Result<T, E>> 变为 Poll<Result<U, E>>，让所有其他成员保持不变。

该函数可用于组合两个函数的结果。

Examples

let res: Poll<Result<u8, _>> = Poll::Ready("12".parse());
let squared = res.map_ok(|n| n * n);
assert_eq!(squared, Poll::Ready(Ok(144)));

pub fn map_err<U, F>(self, f: F) -> Poll<Result<T, U>> where
    F: FnOnce(E) -> U, 

通过对包含的 Poll::Ready(Err) 值应用函数，Maps 将 Poll::Ready<Result<T, E>> 变为 Poll::Ready<Result<T, F>>，让所有其他成员保持不变。

此函数可用于在处理错误时传递成功的结果。

Examples

let res: Poll<Result<u8, _>> = Poll::Ready("oops".parse());
let res = res.map_err(|_| 0_u8);
assert_eq!(res, Poll::Ready(Err(0)));

impl<T, E> Poll<Option<Result<T, E>>>

pub fn map_ok<U, F>(self, f: F) -> Poll<Option<Result<U, E>>> where
    F: FnOnce(T) -> U, 

通过对包含的 Poll::Ready(Some(Ok)) 值应用函数，Maps 将 Poll<Option<Result<T, E>>> 变为 Poll<Option<Result<U, E>>>，让所有其他成员保持不变。

该函数可用于组合两个函数的结果。

Examples

let res: Poll<Option<Result<u8, _>>> = Poll::Ready(Some("12".parse()));
let squared = res.map_ok(|n| n * n);
assert_eq!(squared, Poll::Ready(Some(Ok(144))));

pub fn map_err<U, F>(self, f: F) -> Poll<Option<Result<T, U>>> where
    F: FnOnce(E) -> U, 

通过对包含的 Poll::Ready(Some(Err)) 值应用函数，Maps 将 Poll::Ready<Option<Result<T, E>>> 变为 Poll::Ready<Option<Result<T, F>>>，让所有其他成员保持不变。

此函数可用于在处理错误时传递成功的结果。

Examples

let res: Poll<Option<Result<u8, _>>> = Poll::Ready(Some("oops".parse()));
let res = res.map_err(|_| 0_u8);
assert_eq!(res, Poll::Ready(Some(Err(0))));

Trait Implementations

impl<T> Clone for Poll<T> where
    T: Clone, 

pub fn clone(&self) -> Poll<T>

返回值的副本。

fn clone_from(&mut self, source: &Self)

从 source 执行复制分配。

impl<T> Debug for Poll<T> where
    T: Debug, 

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

使用给定的格式化程序格式化该值。

impl<T> From<T> for Poll<T>

pub fn from(t: T) -> Poll<T>

转换为 Ready 成员。

Example

assert_eq!(Poll::from(true), Poll::Ready(true));

impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Result<T, F>> where
    F: From<E>, 

pub fn from_residual(x: Result<Infallible, E>) -> Poll<Result<T, F>>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

从兼容的 Residual 类型构造类型。

impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Option<Result<T, F>>> where
    F: From<E>, 

pub fn from_residual(x: Result<Infallible, E>) -> Poll<Option<Result<T, F>>>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

从兼容的 Residual 类型构造类型。

impl<T> Hash for Poll<T> where
    T: Hash, 

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

将该值输入给定的 Hasher。

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

将这种类型的切片送入给定的 Hasher 中。

impl<T> Ord for Poll<T> where
    T: Ord, 

pub fn cmp(&self, other: &Poll<T>) -> Ordering

此方法返回 self 和 other 之间的 Ordering。

#[must_use]

fn max(self, other: Self) -> Self

比较并返回两个值中的最大值。

#[must_use]

fn min(self, other: Self) -> Self

比较并返回两个值中的最小值。

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

将值限制为一定的时间间隔。

impl<T> PartialEq<Poll<T>> for Poll<T> where
    T: PartialEq<T>, 

pub fn eq(&self, other: &Poll<T>) -> bool

此方法测试 self 和 other 值是否相等，并由 == 使用。

pub fn ne(&self, other: &Poll<T>) -> bool

此方法测试 !=。

impl<T> PartialOrd<Poll<T>> for Poll<T> where
    T: PartialOrd<T>, 

pub fn partial_cmp(&self, other: &Poll<T>) -> Option<Ordering>

如果存在，则此方法返回 self 和 other 值之间的顺序。

#[must_use]

fn lt(&self, other: &Rhs) -> bool

此方法测试的内容少于 (对于 self 和 other)，并且由 < 操作员使用。

#[must_use]

fn le(&self, other: &Rhs) -> bool

此方法测试小于或等于 (对于 self 和 other)，并且由 <= 运算符使用。

#[must_use]

fn gt(&self, other: &Rhs) -> bool

此方法测试大于 (对于 self 和 other)，并且由 > 操作员使用。

#[must_use]

fn ge(&self, other: &Rhs) -> bool

此方法测试是否大于或等于 (对于 self 和 other)，并且由 >= 运算符使用。

impl<T, E> Try for Poll<Option<Result<T, E>>>

type Output = Poll<Option<T>>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

当不短路时，? 产生的值的类型。

type Residual = Result<Infallible, E>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

短路时作为 ? 的一部分传递给 FromResidual::from_residual 的值的类型。

pub fn from_output(
    c: <Poll<Option<Result<T, E>>> as Try>::Output
) -> Poll<Option<Result<T, E>>>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

从它的 Output 类型构造类型。

pub fn branch(
    self
) -> ControlFlow<<Poll<Option<Result<T, E>>> as Try>::Residual, <Poll<Option<Result<T, E>>> as Try>::Output>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

在 ? 来决定操作符是应该生成一个值 (因为它返回了 ControlFlow::Continue)，还是将一个值传播回调用者(因为它返回了 ControlFlow::Break)。

impl<T, E> Try for Poll<Result<T, E>>

type Output = Poll<T>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

当不短路时，? 产生的值的类型。

type Residual = Result<Infallible, E>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

短路时作为 ? 的一部分传递给 FromResidual::from_residual 的值的类型。

pub fn from_output(c: <Poll<Result<T, E>> as Try>::Output) -> Poll<Result<T, E>>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

从它的 Output 类型构造类型。

pub fn branch(
    self
) -> ControlFlow<<Poll<Result<T, E>> as Try>::Residual, <Poll<Result<T, E>> as Try>::Output>

🔬 This is a nightly-only experimental API. (try_trait_v2 #84277)

在 ? 来决定操作符是应该生成一个值 (因为它返回了 ControlFlow::Continue)，还是将一个值传播回调用者(因为它返回了 ControlFlow::Break)。

impl<T> Copy for Poll<T> where
    T: Copy, 

impl<T> Eq for Poll<T> where
    T: Eq, 

impl<T> StructuralEq for Poll<T>

impl<T> StructuralPartialEq for Poll<T>