pub struct ObjectManagerProxy<'c>(_);
Expand description
Proxy for the org.freedesktop.DBus.ObjectManager
interface.
NB: Changes to properties on existing interfaces are not reported using this interface.
Please use PropertiesProxy::receive_properties_changed
to monitor changes to properties on
objects.
Implementations
Creates a new proxy with the default service & path.
Returns a customizable builder for this proxy.
Consumes self
, returning the underlying zbus::Proxy
.
The return value of this method is a dict whose keys are object paths. All returned object paths are children of the object path implementing this interface, i.e. their object paths start with the ObjectManager’s object path plus ‘/’.
Each value is a dict whose keys are interfaces names. Each value in this inner dict is the same dict that would be returned by the org.freedesktop.DBus.Properties.GetAll() method for that combination of object path and interface. If an interface has no properties, the empty dict is returned.
Create a stream that receives InterfacesAdded
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
This signal is emitted when either a new object is added or when an existing object gains
one or more interfaces. The interfaces_and_properties
argument contains a map with the
interfaces and properties (if any) that have been added to the given object path.
Create a stream that receives InterfacesRemoved
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
This signal is emitted whenever an object is removed or it loses one or more interfaces.
The interfaces
parameters contains a list of the interfaces that were removed.
Methods from Deref<Target = Proxy<'c>>
Get a reference to the associated connection.
Get a reference to the destination service name.
Get a reference to the object path.
Get a reference to the interface.
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>> where
T: TryFrom<OwnedValue>,
T::Error: Into<Error>,
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>> where
T: TryFrom<OwnedValue>,
T::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.
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> where
T: TryFrom<OwnedValue>,
T::Error: Into<Error>,
pub fn get_property<T>(&self, property_name: &str) -> Result<T> where
T: TryFrom<OwnedValue>,
T::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.
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>> where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<Arc<Message>> where
M: TryInto<MemberName<'m>>,
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> where
M: TryInto<MemberName<'m>>,
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> where
M: TryInto<MemberName<'m>>,
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<()> where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_noreply<'m, M, B>(&self, method_name: M, body: &B) -> Result<()> where
M: TryInto<MemberName<'m>>,
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: 'a, M>(
&self,
signal_name: M
) -> Result<SignalIterator<'a>> where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
pub fn receive_signal<'m: 'a, M>(
&self,
signal_name: M
) -> Result<SignalIterator<'a>> where
M: TryInto<MemberName<'m>>,
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).
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: 'a, T>(
&self,
name: &'name str
) -> PropertyIterator<'a, T>ⓘNotable traits for PropertyIterator<'a, T>impl<'a, T> Iterator for PropertyIterator<'a, T> where
T: Unpin, type Item = PropertyChanged<'a, T>;
pub fn receive_property_changed<'name: 'a, T>(
&self,
name: &'name str
) -> PropertyIterator<'a, T>ⓘNotable traits for PropertyIterator<'a, T>impl<'a, T> Iterator for PropertyIterator<'a, T> where
T: Unpin, type Item = PropertyChanged<'a, T>;
impl<'a, T> Iterator for PropertyIterator<'a, T> where
T: Unpin, type Item = PropertyChanged<'a, T>;
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.
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.
Trait Implementations
Auto Trait Implementations
impl<'c> !RefUnwindSafe for ObjectManagerProxy<'c>
impl<'c> Send for ObjectManagerProxy<'c>
impl<'c> Sync for ObjectManagerProxy<'c>
impl<'c> Unpin for ObjectManagerProxy<'c>
impl<'c> !UnwindSafe for ObjectManagerProxy<'c>
Blanket Implementations
Mutably borrows from an owned value. Read more
Get the signature for the implementing type. Read more