tokio_dbus_runtime/
lib.rs

1//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/tokio--dbus-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/tokio-dbus)
2//! [<img alt="crates.io" src="https://img.shields.io/crates/v/tokio-dbus-runtime.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/tokio-dbus-runtime)
3//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-tokio--dbus--runtime-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/tokio-dbus-runtime)
4//!
5//! Runtime support for the code generated by [`tokio-dbus-codegen`].
6//!
7//! Where [`tokio-dbus`] speaks in borrowed views over a message buffer, this
8//! crate speaks in the owned Rust types a caller would reach for anyway:
9//! [`String`], [`Vec`], [`HashMap`] and tuples, with a [`Value`] standing in for
10//! a variant. That convenience is paid for with a copy of every message which
11//! crosses the boundary, so reach for the low level API when that matters.
12//!
13//! [`HashMap`]: https://doc.rust-lang.org/std/collections/struct.HashMap.html
14//! [`tokio-dbus-codegen`]: https://docs.rs/tokio-dbus-codegen
15//! [`tokio-dbus`]: https://docs.rs/tokio-dbus
16//!
17//! <br>
18//!
19//! ## Examples
20//!
21//! ```no_run
22//! use tokio_dbus::{ObjectPath, Signature};
23//! use tokio_dbus_runtime::{Arguments, Connection};
24//!
25//! const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
26//!
27//! # #[tokio::main] async fn main() -> tokio_dbus_runtime::Result<()> {
28//! let mut c = Connection::session_bus().await?;
29//!
30//! let mut arguments = Arguments::new(Signature::STRING)?;
31//! arguments.store("org.freedesktop.DBus");
32//!
33//! let reply = c
34//!     .call(
35//!         "org.freedesktop.DBus",
36//!         PATH,
37//!         "org.freedesktop.DBus",
38//!         "GetNameOwner",
39//!         &arguments,
40//!     )
41//!     .await?;
42//!
43//! let owner = reply.read::<String>()?;
44//! println!("{owner}");
45//! # Ok(()) }
46//! ```
47
48#![deny(missing_docs)]
49
50#[cfg(test)]
51mod tests;
52
53#[doc(inline)]
54pub use self::error::{Error, Result};
55mod error;
56
57#[doc(inline)]
58pub use self::encode::Encode;
59mod encode;
60
61#[doc(inline)]
62pub use self::decode::Decode;
63mod decode;
64
65#[doc(inline)]
66pub use self::value::Value;
67mod value;
68
69#[doc(inline)]
70pub use self::connection::{
71    Arguments, Call, Connection, Incoming, Reply, SignalMessage, VariantDict, decode_variant,
72};
73mod connection;
74
75#[doc(inline)]
76pub use self::name_owner::NameOwnerChanged;
77mod name_owner;
78
79/// Items which generated code refers to, re-exported so that it does not have to
80/// name any crate other than this one.
81#[doc(hidden)]
82pub mod export {
83    pub use tokio_dbus::org_freedesktop_dbus;
84    pub use tokio_dbus::{ObjectPath, ObjectPathBuf, Signature, SignatureBuf};
85}
tokio_dbus_runtime/lib.rs

tokio_dbus_runtime/
lib.rs
