Struct zbus::fdo::ObjectManagerProxy

pub struct ObjectManagerProxy<'c>(_);

Proxy for the org.freedesktop.DBus.ObjectManager interface.

NB: Changes to properties on existing interfaces are not reported using this interface. Please use PropertiesProxy::connect_properties_changed to monitor changes to properties on objects.

Implementations

impl<'c> ObjectManagerProxy<'c>

pub fn new(conn: &Connection) -> Result<Self>

Creates a new proxy with the default service & path.

pub fn new_owned(conn: Connection) -> Result<Self>

Creates a new proxy with the default service & path, taking ownership of conn.

pub fn new_for(
    conn: &Connection,
    destination: &'c str,
    path: impl TryInto<ObjectPath<'c>, Error = Error>
) -> Result<Self>

Creates a new proxy for the given destination and path.

pub fn new_for_owned(
    conn: Connection,
    destination: String,
    path: impl TryInto<ObjectPath<'static>, Error = Error>
) -> Result<Self>

Same as new_for but takes ownership of the passed arguments.

pub fn new_for_path(
    conn: &Connection,
    path: impl TryInto<ObjectPath<'c>, Error = Error>
) -> Result<Self>

Creates a new proxy for the given path.

pub fn new_for_owned_path(
    conn: Connection,
    path: impl TryInto<ObjectPath<'static>, Error = Error>
) -> Result<Self>

Same as new_for_path but takes ownership of the passed arguments.

pub fn into_inner(self) -> Proxy<'c>

Consumes self, returning the underlying zbus::Proxy.

pub fn inner(&self) -> &Proxy<'_>

The reference to the underlying zbus::Proxy.

pub fn get_managed_objects(
    &self
) -> Result<HashMap<OwnedObjectPath, HashMap<String, HashMap<String, OwnedValue>>>>

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.

pub fn connect_interfaces_added<H>(&self, handler: H) -> Result<()> where
    H: FnMut(ObjectPath<'_>, HashMap<&str, HashMap<&str, Value<'_>>>) -> Result<()> + Send + 'static, 

Connect the handler for the InterfacesAdded signal. This is a convenient wrapper around zbus::Proxy::connect_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.

pub fn disconnect_interfaces_added(&self) -> Result<bool>

Disconnected the handler (if any) for the InterfacesAdded signal. This is a convenient wrapper around zbus::Proxy::disconnect_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.

pub fn connect_interfaces_removed<H>(&self, handler: H) -> Result<()> where
    H: FnMut(ObjectPath<'_>, Vec<&str>) -> Result<()> + Send + 'static, 

Connect the handler for the InterfacesRemoved signal. This is a convenient wrapper around zbus::Proxy::connect_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.

pub fn disconnect_interfaces_removed(&self) -> Result<bool>

Disconnected the handler (if any) for the InterfacesRemoved signal. This is a convenient wrapper around zbus::Proxy::disconnect_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.

pub fn introspect(&self) -> Result<String>

Methods from Deref<Target = Proxy<'c>>

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &str

Get a reference to the destination service name.

pub fn path(&self) -> &ObjectPath<'_>

Get a reference to the object path.

pub fn interface(&self) -> &str

Get a reference to the interface.

pub fn introspect(&self) -> Result<String>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub fn get_property<T>(&self, property_name: &str) -> Result<T> where
    T: TryFrom<OwnedValue>, 

Get the property property_name.

Effectively, call the Get method of the org.freedesktop.DBus.Properties interface.

pub fn set_property<'t, T: 't>(
    &self,
    property_name: &str,
    value: T
) -> Result<()> where
    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<B>(&self, method_name: &str, body: &B) -> Result<Message> where
    B: Serialize + Type, 

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<B, R>(&self, method_name: &str, body: &B) -> Result<R> where
    B: Serialize + Type,
    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 connect_signal<H>(
    &self,
    signal_name: &'static str,
    handler: H
) -> Result<()> where
    H: FnMut(&Message) -> Result<()> + Send + 'static, 

Register a handler for signal named signal_name.

Once a handler is successfully registered, call Self::next_signal to wait for the next signal to arrive and be handled by its registered handler.

If the associated connnection is to a bus, a match rule is added for the signal on the bus so that the bus sends us the signals.

Errors

This method can fail if addition of the relevant match rule on the bus fails. You can safely unwrap the Result if you're certain that associated connnection is not a bus connection.

pub fn disconnect_signal(&self, signal_name: &'static str) -> Result<bool>

Deregister the handler for the signal named signal_name.

If the associated connnection is to a bus, the match rule is removed for the signal on the bus so that the bus stops sending us the signal. This method returns Ok(true) if a handler was registered for signal_name and was removed by this call; Ok(false) otherwise.

Errors

This method can fail if removal of the relevant match rule on the bus fails. You can safely unwrap the Result if you're certain that associated connnection is not a bus connection.

pub fn next_signal(&self) -> Result<Option<Message>>

Receive and handle the next incoming signal on the associated connection.

This method will wait for signal messages on the associated connection and call any handlers registered through the Self::connect_signal method. Signal handlers can be registered and deregistered from another threads during the call to this method.

If the signal message was handled by a handler, Ok(None) is returned. Otherwise, the received message is returned.

pub fn handle_signal(&self, msg: &Message) -> Result<bool>

Handle the provided signal message.

Call any handlers registered through the Self::connect_signal method for the provided signal message.

If no errors are encountered, Ok(true) is returned if a handler was found and called for, the signal; Ok(false) otherwise.

pub fn inner(&self) -> &Proxy<'_>

Get a reference to the underlying async Proxy.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for ObjectManagerProxy<'c>

fn as_mut(&mut self) -> &mut Proxy<'c>

Performs the conversion.

impl<'c> AsRef<Proxy<'c>> for ObjectManagerProxy<'c>

fn as_ref(&self) -> &Proxy<'c>

Performs the conversion.

impl<'c> Debug for ObjectManagerProxy<'c>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'c> Deref for ObjectManagerProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'c> DerefMut for ObjectManagerProxy<'c>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.