ready.rs - source
Description: Source of the Rust file `library/core/src/task/ready.rs`.
Keywords: rust, rustlang, rust-lang

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61

    /// Extracts the successful type of a [`Poll<T>`].
    ///
    /// This macro bakes in propagation of [`Pending`] signals by returning early.
    ///
    /// [`Poll<T>`]: crate::task::Poll
    /// [`Pending`]: crate::task::Poll::Pending
    ///
    /// # Examples
    ///
    /// ```
    /// #![feature(ready_macro)]
    ///
    /// use std::task::{ready, Context, Poll};
    /// use std::future::{self, Future};
    /// use std::pin::Pin;
    ///
    /// pub fn do_poll(cx: &mut Context<'_>) -> Poll<()> {
    ///     let mut fut = future::ready(42);
    ///     let fut = Pin::new(&mut fut);
    ///
    ///     let num = ready!(fut.poll(cx));
    ///     # drop(num);
    ///     // ... use num
    ///
    ///     Poll::Ready(())
    /// }
    /// ```
    ///
    /// The `ready!` call expands to:
    ///
    /// ```
    /// # #![feature(ready_macro)]
    /// #
    /// # use std::task::{Context, Poll};
    /// # use std::future::{self, Future};
    /// # use std::pin::Pin;
    /// #
    /// # pub fn do_poll(cx: &mut Context<'_>) -> Poll<()> {
    ///     # let mut fut = future::ready(42);
    ///     # let fut = Pin::new(&mut fut);
    ///     #
    /// let num = match fut.poll(cx) {
    ///     Poll::Ready(t) => t,
    ///     Poll::Pending => return Poll::Pending,
    /// };
    ///     # drop(num);
    ///     # // ... use num
    ///     #
    ///     # Poll::Ready(())
    /// # }
    /// ```
    #[unstable(feature = "ready_macro", issue = "70922")]
    #[rustc_macro_transparency = "semitransparent"]
    pub macro ready($e:expr) {
        match $e {
            $crate::task::Poll::Ready(t) => t,
            $crate::task::Poll::Pending => {
                return $crate::task::Poll::Pending;
            }
        }
    }