Struct souk::main::dbus_proxy::WorkerProxyBlocking
source · pub struct WorkerProxyBlocking<'c>(Proxy<'c>);
Tuple Fields§
§0: Proxy<'c>
Implementations§
source§impl<'c> WorkerProxyBlocking<'c>
impl<'c> WorkerProxyBlocking<'c>
sourcepub fn new(conn: &Connection) -> Result<WorkerProxyBlocking<'c>>
pub fn new(conn: &Connection) -> Result<WorkerProxyBlocking<'c>>
Creates a new proxy with the default service & path.
sourcepub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
Returns a customizable builder for this proxy.
sourcepub fn into_inner(self) -> Proxy<'c>
pub fn into_inner(self) -> Proxy<'c>
Consumes self
, returning the underlying zbus::Proxy
.
pub fn run_task(&self, task: Task) -> Result<()>
pub fn cancel_task(&self, task: Task) -> Result<()>
sourcepub fn receive_task_response(&self) -> Result<TaskResponseIterator<'c>>
pub fn receive_task_response(&self) -> Result<TaskResponseIterator<'c>>
Create a stream that receives TaskResponse
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
Methods from Deref<Target = Proxy<'c>>§
pub fn connection(&self) -> &Connection
pub fn connection(&self) -> &Connection
Get a reference to the associated connection.
pub fn destination(&self) -> &BusName<'_>
pub fn destination(&self) -> &BusName<'_>
Get a reference to the destination service name.
pub fn path(&self) -> &ObjectPath<'_>
pub fn path(&self) -> &ObjectPath<'_>
Get a reference to the object path.
pub fn interface(&self) -> &InterfaceName<'_>
pub fn interface(&self) -> &InterfaceName<'_>
Get a reference to the interface.
pub fn introspect(&self) -> Result<String, Error>
pub fn introspect(&self) -> Result<String, Error>
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
Get the cached value of the property property_name
.
This returns None
if the property is not in the cache. This could be because the cache
was invalidated by an update, because caching was disabled for this property or proxy, or
because the cache has not yet been populated. Use get_property
to fetch the value from
the peer.
pub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>
pub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>
Get the cached value of the property property_name
.
Same as cached_property
, but gives you access to the raw value stored in the cache. This
is useful if you want to avoid allocations and cloning.
pub fn get_property<T>(&self, property_name: &str) -> Result<T, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
pub fn get_property<T>(&self, property_name: &str) -> Result<T, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
Get the property property_name
.
Get the property value from the cache or call the Get
method of the
org.freedesktop.DBus.Properties
interface.
pub fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> Result<(), Error>where
T: 't + Into<Value<'t>>,
pub fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> Result<(), Error>where
T: 't + Into<Value<'t>>,
Set the property property_name
.
Effectively, call the Set
method of the org.freedesktop.DBus.Properties
interface.
pub fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<Arc<Message>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<Arc<Message>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
Call a method and return the reply.
Typically, you would want to use call
method instead. Use this method if you need to
deserialize the reply message manually (this way, you can avoid the memory
allocation/copying, by deserializing the reply to an unowned type).
pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
Call a method and return the reply body.
Use call_method
instead if you need to deserialize the reply manually/separately.
pub fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<(), Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<(), Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
Call a method without expecting a reply
This sets the NoReplyExpected
flag on the calling message and does not wait for a reply.
pub fn receive_signal<'m, M>(
&self,
signal_name: M
) -> Result<SignalIterator<'a>, Error>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub fn receive_signal<'m, M>(
&self,
signal_name: M
) -> Result<SignalIterator<'a>, Error>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
Create a stream for signal named signal_name
.
Errors
Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).
pub fn receive_all_signals(&self) -> Result<SignalIterator<'a>, Error>
pub fn receive_all_signals(&self) -> Result<SignalIterator<'a>, Error>
Create a stream for all signals emitted by this service.
Errors
Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).
pub fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> PropertyIterator<'a, T>where
'name: 'a,
pub fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> PropertyIterator<'a, T>where
'name: 'a,
Get an iterator to receive owner changed events.
If the proxy destination is a unique name, the stream will be notified of the peer
disconnection from the bus (with a None
value).
If the proxy destination is a well-known name, the stream will be notified whenever the name
owner is changed, either by a new peer being granted ownership (Some
value) or when the
name is released (with a None
value).
Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.
pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>
pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>
Get an iterator to receive property changed events.
Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.
pub fn inner(&self) -> &Proxy<'a>
pub fn inner(&self) -> &Proxy<'a>
Get a reference to the underlying async Proxy.
Trait Implementations§
source§impl<'c> AsMut<Proxy<'c>> for WorkerProxyBlocking<'c>
impl<'c> AsMut<Proxy<'c>> for WorkerProxyBlocking<'c>
source§impl<'c> AsRef<Proxy<'c>> for WorkerProxyBlocking<'c>
impl<'c> AsRef<Proxy<'c>> for WorkerProxyBlocking<'c>
source§impl<'c> Clone for WorkerProxyBlocking<'c>
impl<'c> Clone for WorkerProxyBlocking<'c>
source§fn clone(&self) -> WorkerProxyBlocking<'c>
fn clone(&self) -> WorkerProxyBlocking<'c>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more