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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
use std::{collections::HashSet, convert::TryInto, marker::PhantomData, sync::Arc};
use static_assertions::assert_impl_all;
use zbus_names::{BusName, InterfaceName};
use zvariant::{ObjectPath, Str};
use crate::{Connection, Error, Proxy, ProxyInner, Result};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum CacheProperties {
Yes,
No,
Lazily,
}
impl Default for CacheProperties {
fn default() -> Self {
CacheProperties::Lazily
}
}
#[derive(Debug)]
pub struct ProxyBuilder<'a, T = ()> {
conn: Connection,
destination: Option<BusName<'a>>,
path: Option<ObjectPath<'a>>,
interface: Option<InterfaceName<'a>>,
proxy_type: PhantomData<T>,
cache: CacheProperties,
uncached_properties: HashSet<Str<'a>>,
}
impl<'a, T> Clone for ProxyBuilder<'a, T> {
fn clone(&self) -> Self {
Self {
conn: self.conn.clone(),
destination: self.destination.clone(),
path: self.path.clone(),
interface: self.interface.clone(),
cache: self.cache,
uncached_properties: self.uncached_properties.clone(),
proxy_type: PhantomData,
}
}
}
assert_impl_all!(ProxyBuilder<'_>: Send, Sync, Unpin);
impl<'a, T> ProxyBuilder<'a, T> {
#[must_use]
pub fn new_bare(conn: &Connection) -> Self {
Self {
conn: conn.clone(),
destination: None,
path: None,
interface: None,
cache: CacheProperties::default(),
uncached_properties: HashSet::new(),
proxy_type: PhantomData,
}
}
}
impl<'a, T> ProxyBuilder<'a, T> {
pub fn destination<D>(mut self, destination: D) -> Result<Self>
where
D: TryInto<BusName<'a>>,
D::Error: Into<Error>,
{
self.destination = Some(destination.try_into().map_err(Into::into)?);
Ok(self)
}
pub fn path<P>(mut self, path: P) -> Result<Self>
where
P: TryInto<ObjectPath<'a>>,
P::Error: Into<Error>,
{
self.path = Some(path.try_into().map_err(Into::into)?);
Ok(self)
}
pub fn interface<I>(mut self, interface: I) -> Result<Self>
where
I: TryInto<InterfaceName<'a>>,
I::Error: Into<Error>,
{
self.interface = Some(interface.try_into().map_err(Into::into)?);
Ok(self)
}
#[must_use]
pub fn cache_properties(mut self, cache: CacheProperties) -> Self {
self.cache = cache;
self
}
#[must_use]
pub fn uncached_properties(mut self, properties: &[&'a str]) -> Self {
for prop_name in properties {
self.uncached_properties.insert(Str::from(*prop_name));
}
self
}
pub(crate) fn build_internal(self) -> Proxy<'a> {
let conn = self.conn;
let destination = self.destination.expect("missing `destination`");
let path = self.path.expect("missing `path`");
let interface = self.interface.expect("missing `interface`");
let cache = self.cache;
let mut uncached_properties = self.uncached_properties;
uncached_properties.shrink_to_fit();
Proxy {
inner: Arc::new(ProxyInner::new(
conn,
destination,
path,
interface,
cache,
uncached_properties,
)),
}
}
pub async fn build(self) -> Result<T>
where
T: From<Proxy<'a>>,
{
let cache_upfront = self.cache == CacheProperties::Yes;
let proxy = self.build_internal();
if cache_upfront {
proxy
.get_property_cache()
.expect("properties cache not initialized")
.ready()
.await?;
}
Ok(proxy.into())
}
}
impl<'a, T> ProxyBuilder<'a, T>
where
T: ProxyDefault,
{
#[must_use]
pub fn new(conn: &Connection) -> Self {
Self {
conn: conn.clone(),
destination: Some(BusName::from_static_str(T::DESTINATION).expect("invalid bus name")),
path: Some(ObjectPath::from_static_str(T::PATH).expect("invalid default path")),
interface: Some(
InterfaceName::from_static_str(T::INTERFACE).expect("invalid interface name"),
),
cache: CacheProperties::default(),
uncached_properties: HashSet::new(),
proxy_type: PhantomData,
}
}
}
pub trait ProxyDefault {
const INTERFACE: &'static str;
const DESTINATION: &'static str;
const PATH: &'static str;
}
#[cfg(test)]
mod tests {
use super::*;
use test_log::test;
#[test]
#[ntest::timeout(15000)]
fn builder() {
crate::utils::block_on(builder_async());
}
async fn builder_async() {
let conn = Connection::session().await.unwrap();
let builder = ProxyBuilder::<Proxy<'_>>::new_bare(&conn)
.destination("org.freedesktop.DBus")
.unwrap()
.path("/some/path")
.unwrap()
.interface("org.freedesktop.Interface")
.unwrap()
.cache_properties(CacheProperties::No);
assert!(matches!(
builder.clone().destination.unwrap(),
BusName::Unique(_),
));
let proxy = builder.build().await.unwrap();
assert!(matches!(proxy.inner.destination, BusName::Unique(_)));
}
}