Struct zbus::fdo::PropertiesProxy

pub struct PropertiesProxy<'c>(_);

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

Implementations

impl<'c> PropertiesProxy<'c>

pub async fn new(conn: &Connection) -> Result<PropertiesProxy<'c>>

Creates a new proxy with the default service & path.

pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>

Returns a customizable builder for this proxy.

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

Consumes self, returning the underlying zbus::Proxy.

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

The reference to the underlying zbus::Proxy.

pub async fn get(
    &self,
    interface_name: InterfaceName<'_>,
    property_name: &str
) -> Result<OwnedValue>

Get a property value.

pub async fn set(
    &self,
    interface_name: InterfaceName<'_>,
    property_name: &str,
    value: &Value<'_>
) -> Result<()>

Set a property value.

pub async fn get_all(
    &self,
    interface_name: InterfaceName<'_>
) -> Result<HashMap<String, OwnedValue>>

Get all properties.

pub async fn connect_properties_changed<__H>(
    &self,
    handler: __H
) -> Result<SignalHandlerId> where
    __H: FnMut(InterfaceName<'_>, HashMap<&str, Value<'_>>, Vec<&str>) -> BoxFuture<'static, ()> + Send + 'static, 

Connect the handler for the PropertiesChanged signal. This is a convenient wrapper around zbus::Proxy::connect_signal.

pub async fn receive_properties_changed(
    &self
) -> Result<PropertiesChangedStream<'c>>

Create a stream that receives PropertiesChanged signals.

This a convenient wrapper around zbus::Proxy::receive_signal.

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

pub async fn connect_property_changed<H>(
    &self,
    property_name: &'static str,
    handler: H
) -> Result<PropertyChangedHandlerId> where
    for<'v> H: FnMut(Option<&'v Value<'_>>) -> BoxFuture<'v, ()> + 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_property_changed method.

Note: The signal handler will be called by the executor thread of the Connection. See the 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

The current implementation requires cached properties. It returns an Error::Unsupported if the proxy isn’t setup with cache.

pub async fn disconnect_property_changed(
    &self,
    handler_id: PropertyChangedHandlerId
) -> Result<bool>

Deregister the property 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.

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

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

Get a reference to the destination service name.

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

Get a reference to the object path.

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

Get a reference to the interface.

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

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>, 

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 async 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 (if caching is enabled on this proxy) or call the Get method of the org.freedesktop.DBus.Properties interface.

pub async 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 async 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 async 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 async fn receive_signal<M>(
    &self,
    signal_name: M
) -> Result<SignalStream<'a>> where
    M: TryInto<MemberName<'static>>,
    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 async fn connect_signal<M, H>(
    &self,
    signal_name: M,
    handler: H
) -> Result<SignalHandlerId> where
    M: TryInto<MemberName<'static>>,
    M::Error: Into<Error>,
    for<'msg> H: FnMut(&'msg Message) -> BoxFuture<'msg, ()> + 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 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.

pub async 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.

pub async fn receive_property_stream<'n, T>(
    &self,
    name: &'n str
) -> PropertyStream<'n, T>

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.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'c> Clone for PropertiesProxy<'c>

fn clone(&self) -> PropertiesProxy<'c>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'c> Debug for PropertiesProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for PropertiesProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for PropertiesProxy<'c>

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

Mutably dereferences the value.

impl<'c> From<Proxy<'c>> for PropertiesProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'a> ProxyDefault for PropertiesProxy<'a>

const INTERFACE: &'static str

const DESTINATION: &'static str

const PATH: &'static str

impl<'c> Serialize for PropertiesProxy<'c>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'c> Type for PropertiesProxy<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.