tokio-dbus 0.2.0

Pure Rust D-Bus implementation for Tokio.
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

use crate::Body;
#[cfg(feature = "alloc")]
use crate::BodyBuf;

mod sealed {
    pub trait Sealed<'de> {}

    impl<'de> Sealed<'de> for &crate::Body<'de> {}
    impl<'de> Sealed<'de> for crate::Body<'de> {}
    #[cfg(feature = "alloc")]
    impl<'de> Sealed<'de> for &'de crate::BodyBuf {}
    #[cfg(feature = "alloc")]
    impl<'de> Sealed<'de> for &'de mut crate::BodyBuf {}
}

/// Trait for types which can be cheaply coerced into a [`Body`].
///
/// This is used in combination with [`Message::with_body`] to allow for
/// convenient construction of a borrowed body.
///
/// [`Message::with_body`]: crate::Message::with_body
///
/// # Examples
///
/// ```
/// use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};
///
/// const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
///
/// let mut send = SendBuf::new();
/// let mut body = BodyBuf::new();
///
/// body.store("Hello World!");
///
/// let m = send.method_call(PATH, "Hello")
///     .with_body(&body);
///
/// assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
/// assert_eq!(m.signature(), Signature::STRING);
/// ```
pub trait AsBody<'de>: self::sealed::Sealed<'de> {
    /// Coerce this type into a [`Body`].
    #[allow(clippy::wrong_self_convention)]
    fn as_body(self) -> Body<'de>;
}

/// Convert a reference to a [`Body`] into a [`Body`].
///
/// Since [`Body`] is cheap to clone, it doesn't hurt to provide this coercions.
///
/// # Examples
///
/// ```
/// use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};
///
/// const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
///
/// let mut send = SendBuf::new();
/// let mut body = BodyBuf::new();
///
/// body.store("Hello World!");
///
/// let m = send.method_call(PATH, "Hello")
///     .with_body(&body.as_body());
///
/// assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
/// assert_eq!(m.signature(), Signature::STRING);
/// ```
impl<'de> AsBody<'de> for &Body<'de> {
    #[inline]
    fn as_body(self) -> Body<'de> {
        self.clone()
    }
}

/// Convert a [`Body`] into a [`Body`].
///
/// # Examples
///
/// ```
/// use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};
///
/// const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
///
/// let mut send = SendBuf::new();
/// let mut body = BodyBuf::new();
///
/// body.store("Hello World!");
///
/// let m = send.method_call(PATH, "Hello")
///     .with_body(body.as_body());
///
/// assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
/// assert_eq!(m.signature(), Signature::STRING);
/// ```
impl<'de> AsBody<'de> for Body<'de> {
    #[inline]
    fn as_body(self) -> Body<'de> {
        self
    }
}

/// Convert a borrowed [`BodyBuf`] into a [`Body`].
///
/// # Examples
///
/// ```
/// use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};
///
/// const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
///
/// let mut send = SendBuf::new();
/// let mut body = BodyBuf::new();
///
/// body.store("Hello World!");
///
/// let m = send.method_call(PATH, "Hello")
///     .with_body(&body);
///
/// assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
/// assert_eq!(m.signature(), Signature::STRING);
/// ```
#[cfg(feature = "alloc")]
impl<'de> AsBody<'de> for &'de BodyBuf {
    #[inline]
    fn as_body(self) -> Body<'de> {
        BodyBuf::as_body(self)
    }
}

/// Convert a mutably borrowed [`BodyBuf`] into a [`Body`].
///
/// # Examples
///
/// ```
/// use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};
///
/// const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");
///
/// let mut send = SendBuf::new();
/// let mut body = BodyBuf::new();
///
/// body.store("Hello World!");
///
/// let m = send.method_call(PATH, "Hello")
///     .with_body(&mut body);
///
/// assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
/// assert_eq!(m.signature(), Signature::STRING);
/// ```
#[cfg(feature = "alloc")]
impl<'de> AsBody<'de> for &'de mut BodyBuf {
    #[inline]
    fn as_body(self) -> Body<'de> {
        BodyBuf::as_body(self)
    }
}