Struct zbus::blocking::fdo::IntrospectableProxy[−][src]

Returns an XML description of the object, including its interfaces (with signals and methods), objects below it in the object path tree, and its properties.

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

[src]

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

[src]

pub fn destination(&self) -> &BusName<'_>

Get a reference to the destination service name.

[src]

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

Get a reference to the object path.

[src]

pub fn interface(&self) -> &InterfaceName<'_>

Get a reference to the interface.

[src]

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

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

[src]

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

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.

[src]

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

Get the property property_name.

Get the property value from the cache or call the Get method of the org.freedesktop.DBus.Properties interface.

[src]

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.

[src]

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).

[src]

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.

[src]

pub fn connect_signal<M, H>(
 &self,
 signal_name: M,
 handler: H
) -> Result<SignalHandlerId> where
 M: TryInto<MemberName<'static>>,
 M::Error: Into<Error>,
 H: FnMut(&Message) + Send + 'static,

Register a handler for signal named signal_name.

A unique ID for the handler is returned, which can be used to deregister this handler using Self::disconnect_signal method.

Note: The signal handler will be called by the executor thread of the Connection. See the crate::Connection::executor documentation for an example of how you can run the executor (and in turn all the signal handlers called) in your own thread.

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 connection is not a bus connection.

[src]

pub fn disconnect_signal(&self, handler_id: SignalHandlerId) -> Result<bool>

Deregister the signal handler with the ID handler_id.

This method returns Ok(true) if a handler with the id handler_id is found and removed; 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 connection is not a bus connection.

[src]

pub fn connect_property_changed<H>(
 &self,
 property_name: &'static str,
 handler: H
) -> Result<PropertyChangedHandlerId> where
 H: FnMut(Option<&Value<'_>>) + Send + 'static,

Register a changed handler for the property named property_name.

A unique ID for the handler is returned, which can be used to deregister this handler using Self::disconnect_signal method.

Note: The signal handler will be called by the executor thread of the Connection. See the crate::Connection::executor documentation for an example of how you can run the executor (and in turn all the signal handlers called) in your own thread.