zbus 5.19.0

API for D-Bus communication
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
67
68
69
70
71
72
73
74
75
76
77
78
79

//! This mod contains a bunch of abstractions.
//!
//! These abstractions allow us to make use of the appropriate API depending on which features are
//! enabled.

/// Evaluates the `tokio` or `async-io` expression for the active backend.
///
/// With a single backend it resolves to that backend's expression at compile time; with both it
/// picks at runtime via [`use_tokio`]. The inactive arm is `cfg`-stripped, so each arm only needs
/// to be valid in the configurations where its backend is compiled in.
///
/// The choice is re-evaluated on every call, so this is only safe where it doesn't need to match a
/// particular connection's backend. A connection latches its backend once at build time (see
/// [`Executor::new`]); use that instead of this macro for anything tied to the socket's reactor.
/// The current call sites (timers, the blocking pool) are independent of the socket, so a per-call
/// decision is fine.
macro_rules! select_runtime {
    (tokio: $tokio:expr, async_io: $async_io:expr $(,)?) => {{
        #[cfg(all(feature = "tokio", feature = "async-io"))]
        {
            if $crate::abstractions::use_tokio() {
                $tokio
            } else {
                $async_io
            }
        }
        #[cfg(all(feature = "tokio", not(feature = "async-io")))]
        {
            $tokio
        }
        #[cfg(all(feature = "async-io", not(feature = "tokio")))]
        {
            $async_io
        }
    }};
}
pub(crate) use select_runtime;

/// Whether zbus should use tokio (rather than `async-io`) for its I/O.
///
/// Only consulted when `async-io` is compiled in, since that's the only time there's a choice. With
/// both backends we use tokio when a tokio runtime is active on the current thread; with only
/// `async-io` the answer is always `false`. This keeps the features additive: enabling `tokio`
/// elsewhere in the dependency graph doesn't force every zbus user into a tokio runtime.
#[cfg(feature = "async-io")]
pub(crate) fn use_tokio() -> bool {
    #[cfg(feature = "tokio")]
    {
        tokio::runtime::Handle::try_current().is_ok()
    }
    #[cfg(not(feature = "tokio"))]
    {
        false
    }
}

mod executor;
pub use executor::*;
mod async_drop;
pub(crate) mod async_lock;
pub use async_drop::*;
pub(crate) mod timeout;

// Not unix-specific itself but only used on unix.
#[cfg(target_family = "unix")]
pub(crate) mod process;

#[cfg(all(test, feature = "tokio", feature = "async-io"))]
mod tests {
    #[test]
    fn use_tokio_reflects_active_runtime() {
        assert!(!super::use_tokio(), "no runtime is active here");
        let runtime = tokio::runtime::Runtime::new().unwrap();
        assert!(
            runtime.block_on(async { super::use_tokio() }),
            "a tokio runtime is active",
        );
    }
}