Struct souk::main::dbus_proxy::WorkerProxy
source · pub struct WorkerProxy<'c>(Proxy<'c>);
Tuple Fields§
§0: Proxy<'c>
Implementations§
source§impl<'c> WorkerProxy<'c>
impl<'c> WorkerProxy<'c>
sourcepub async fn new(conn: &Connection) -> Result<WorkerProxy<'c>>
pub async fn new(conn: &Connection) -> Result<WorkerProxy<'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 async fn run_task(&self, task: Task) -> Result<()>
pub async fn cancel_task(&self, task: Task) -> Result<()>
sourcepub async fn receive_task_response(&self) -> Result<TaskResponseStream<'c>>
pub async fn receive_task_response(&self) -> Result<TaskResponseStream<'c>>
Create a stream that receives TaskResponse
signals.
This a convenient wrapper around zbus::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 async fn introspect(&self) -> impl Future<Output = Result<String, Error>>
pub async fn introspect(&self) -> impl Future<Output = 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 async fn get_property<T>(
&self,
property_name: &str
) -> impl Future<Output = Result<T, Error>>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
pub async fn get_property<T>(
&self,
property_name: &str
) -> impl Future<Output = 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 (if caching is enabled) or call the
Get
method of the org.freedesktop.DBus.Properties
interface.
pub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = Result<(), Error>>where
T: 't + Into<Value<'t>>,
pub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = 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 async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<Arc<Message>, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<R, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<(), Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = Result<SignalStream<'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
.
pub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
pub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
Create a stream for all signals emitted by this service.
pub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = PropertyStream<'a, T>>where
'name: 'a,
pub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = PropertyStream<'a, T>>where
'name: 'a,
Get a stream 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.
If caching is not enabled on this proxy, the resulting stream will not return any events.
pub async fn receive_owner_changed(
&self
) -> impl Future<Output = Result<OwnerChangedStream<'_>, Error>>
pub async fn receive_owner_changed(
&self
) -> impl Future<Output = Result<OwnerChangedStream<'_>, Error>>
Get a stream to receive destination 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.
Trait Implementations§
source§impl<'c> AsMut<Proxy<'c>> for WorkerProxy<'c>
impl<'c> AsMut<Proxy<'c>> for WorkerProxy<'c>
source§impl<'c> AsRef<Proxy<'c>> for WorkerProxy<'c>
impl<'c> AsRef<Proxy<'c>> for WorkerProxy<'c>
source§impl<'c> Clone for WorkerProxy<'c>
impl<'c> Clone for WorkerProxy<'c>
source§fn clone(&self) -> WorkerProxy<'c>
fn clone(&self) -> WorkerProxy<'c>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more