devela/work/future/
ext.rs

Help
1// devela::work::future::ext
2//
3//!
4//
5
6#[cfg(feature = "std")]
7#[cfg(not(feature = "dep_portable_atomic_util"))]
8use crate::future_block;
9
10use {
11    crate::{Future, FuturePending, FuturePollFn, FutureReady, TaskContext, TaskPoll},
12    ::core::future::{pending, poll_fn, ready},
13};
14
15impl<F: Future> ExtFuture for F {}
16
17/// Extension trait providing additional methods for [`Future`]s.
18pub trait ExtFuture: Future {
19    /// Blocks the thread until the future is ready.
20    ///
21    /// # Example
22    /// ```
23    /// use devela::ExtFuture as _;
24    ///
25    /// let future = async {};
26    /// let result = future.block_on();
27    /// ```
28    /// # Features
29    /// This method is only available if the `dep_portable_atomic_util` feature is **disabled**,
30    /// because its `Arc` type can't be used as a `self` type.
31    /// See [arbitrary_self_types](https://github.com/rust-lang/rust/issues/44874).
32    ///
33    #[doc = crate::doc_!(vendor: "pollster")]
34    #[rustfmt::skip]
35    #[cfg(feature = "std")]
36    #[cfg_attr(feature = "nightly_doc", doc(cfg(feature = "std")))]
37    #[cfg(not(feature = "dep_portable_atomic_util"))]
38    #[cfg_attr(feature = "nightly_doc", doc(cfg(not(feature = "dep_portable_atomic_util"))))]
39    // WAIT: [arbitrary_self_types](https://github.com/rust-lang/rust/pull/135881)
40    fn block_on(self) -> Self::Output where Self: Sized { future_block(self) }
41
42    /// Creates a future which never resolves.
43    #[rustfmt::skip]
44    fn pending<T>() -> FuturePending<T> { pending() }
45
46    /// Creates a future that wraps a `function` returning [`TaskPoll`].
47    #[rustfmt::skip]
48    fn poll_fn<T, F>(function: F) -> FuturePollFn<F>
49    where F: FnMut(&mut TaskContext<'_>) -> TaskPoll<T> { poll_fn(function) }
50
51    /// Creates a future that is immediately ready with a `value`.
52    #[rustfmt::skip]
53    fn ready<T>(value: T) -> FutureReady<T> { ready(value) }
54}
devela/work/future/ext.rs

devela/work/future/
ext.rs
