devela 0.27.0

A development layer of coherence.
Documentation 
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
62
63
64
65
66

// devela::work::future::ext
//
//!
//

#[cfg(feature = "std")]
#[cfg(not(feature = "dep_portable_atomic_util"))]
use crate::future_block;

use {
    crate::{Future, FuturePending, FuturePollFn, FutureReady, TaskContext, TaskPoll},
    ::core::future::{pending, poll_fn, ready},
};

impl<F: Future> FutureExt for F {}

#[cfg(feature = "std")]
crate::CONST! {
    DOC_BLOCK_ON = r#"Blocks the thread until the future is ready.
# Example
```
# #[cfg(not(feature = "dep_portable_atomic_util"))] {
# use devela::FutureExt as _;
let future = async {};
let result = future.block_on();
# }
```
# Features
This method is only available if the `dep_portable_atomic_util` feature is **disabled**,
because its `Arc` type can't be used as a `self` type.
See [arbitrary_self_types](https://github.com/rust-lang/rust/issues/44874).
"#;
}

#[doc = crate::_tags!(concurrency runtime)]
/// Extension trait providing additional methods for [`Future`]s.
#[doc = crate::_doc_location!("work/future")]
#[rustfmt::skip]
pub trait FutureExt: Future {
    #[doc = DOC_BLOCK_ON!()]
    #[doc = crate::_doc!(vendor: "pollster")]
    #[cfg(feature = "std")]
    #[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
    #[cfg(not(feature = "dep_portable_atomic_util"))]
    #[cfg_attr(nightly_doc, doc(cfg(not(feature = "dep_portable_atomic_util"))))]
    // WAIT: [arbitrary_self_types](https://github.com/rust-lang/rust/pull/135881)
    fn block_on(self) -> Self::Output where Self: Sized { future_block(self) }
    #[doc = DOC_BLOCK_ON!()]
    #[doc = crate::_doc!(vendor: "pollster")]
    #[cfg(all(feature = "std", feature = "dep_portable_atomic_util"))]
    #[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
    #[cfg_attr(nightly_doc, doc(cfg(not(feature = "dep_portable_atomic_util"))))]
    fn block_on(self) -> Self::Output where Self: Sized {
        panic!("block_on is unavailable when `dep_portable_atomic_util` is enabled.");
    }

    /// Creates a future which never resolves.
    fn pending<T>() -> FuturePending<T> { pending() }

    /// Creates a future that wraps a `function` returning [`TaskPoll`].
    fn poll_fn<T, F>(function: F) -> FuturePollFn<F>
    where F: FnMut(&mut TaskContext<'_>) -> TaskPoll<T> { poll_fn(function) }

    /// Creates a future that is immediately ready with a `value`.
    fn ready<T>(value: T) -> FutureReady<T> { ready(value) }
}