Struct upower_dbus::DeviceProxyBlocking

pub struct DeviceProxyBlocking<'c>(_);

Implementations

impl<'c> DeviceProxyBlocking<'c>

pub fn new(conn: &Connection) -> Result<DeviceProxyBlocking<'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 fn battery_level(&self) -> Result<BatteryLevel>

pub fn cached_battery_level(
    &self
) -> Result<Option<<Result<BatteryLevel> as ResultAdapter>::Ok>, <Result<BatteryLevel> as ResultAdapter>::Err>

Get the cached value of the BatteryLevel property, or None if the property is not cached.

pub fn receive_battery_level_changed(
    &self
) -> PropertyIterator<'c, <Result<BatteryLevel> as ResultAdapter>::Ok>

Create a stream for the BatteryLevel property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn capacity(&self) -> Result<f64>

pub fn cached_capacity(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Capacity property, or None if the property is not cached.

pub fn receive_capacity_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Capacity property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn energy(&self) -> Result<f64>

pub fn cached_energy(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Energy property, or None if the property is not cached.

pub fn receive_energy_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Energy property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn energy_empty(&self) -> Result<f64>

pub fn cached_energy_empty(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the EnergyEmpty property, or None if the property is not cached.

pub fn receive_energy_empty_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the EnergyEmpty property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn energy_full(&self) -> Result<f64>

pub fn cached_energy_full(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the EnergyFull property, or None if the property is not cached.

pub fn receive_energy_full_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the EnergyFull property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn energy_full_design(&self) -> Result<f64>

pub fn cached_energy_full_design(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the EnergyFullDesign property, or None if the property is not cached.

pub fn receive_energy_full_design_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the EnergyFullDesign property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_has_history(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the HasHistory property, or None if the property is not cached.

pub fn receive_has_history_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the HasHistory property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_has_statistics(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the HasStatistics property, or None if the property is not cached.

pub fn receive_has_statistics_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the HasStatistics property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_icon_name(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the IconName property, or None if the property is not cached.

pub fn receive_icon_name_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the IconName property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_is_present(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the IsPresent property, or None if the property is not cached.

pub fn receive_is_present_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the IsPresent property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_is_rechargeable(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the IsRechargeable property, or None if the property is not cached.

pub fn receive_is_rechargeable_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the IsRechargeable property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn luminosity(&self) -> Result<f64>

pub fn cached_luminosity(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Luminosity property, or None if the property is not cached.

pub fn receive_luminosity_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Luminosity property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_model(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the Model property, or None if the property is not cached.

pub fn receive_model_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the Model property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_native_path(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the NativePath property, or None if the property is not cached.

pub fn receive_native_path_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the NativePath property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_online(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the Online property, or None if the property is not cached.

pub fn receive_online_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the Online property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn percentage(&self) -> Result<f64>

pub fn cached_percentage(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Percentage property, or None if the property is not cached.

pub fn receive_percentage_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Percentage property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_power_supply(
    &self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>

Get the cached value of the PowerSupply property, or None if the property is not cached.

pub fn receive_power_supply_changed(
    &self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the PowerSupply property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn refresh(&self) -> Result<()>

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

pub fn cached_serial(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the Serial property, or None if the property is not cached.

pub fn receive_serial_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the Serial property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn state(&self) -> Result<BatteryState>

pub fn cached_state(
    &self
) -> Result<Option<<Result<BatteryState> as ResultAdapter>::Ok>, <Result<BatteryState> as ResultAdapter>::Err>

Get the cached value of the State property, or None if the property is not cached.

pub fn receive_state_changed(
    &self
) -> PropertyIterator<'c, <Result<BatteryState> as ResultAdapter>::Ok>

Create a stream for the State property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn temperature(&self) -> Result<f64>

pub fn cached_temperature(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Temperature property, or None if the property is not cached.

pub fn receive_temperature_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Temperature property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn type_(&self) -> Result<BatteryType>

pub fn cached_type_(
    &self
) -> Result<Option<<Result<BatteryType> as ResultAdapter>::Ok>, <Result<BatteryType> as ResultAdapter>::Err>

Get the cached value of the Type property, or None if the property is not cached.

pub fn receive_type__changed(
    &self
) -> PropertyIterator<'c, <Result<BatteryType> as ResultAdapter>::Ok>

Create a stream for the Type property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

pub fn cached_vendor(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the Vendor property, or None if the property is not cached.

pub fn receive_vendor_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the Vendor property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn voltage(&self) -> Result<f64>

pub fn cached_voltage(
    &self
) -> Result<Option<<Result<f64> as ResultAdapter>::Ok>, <Result<f64> as ResultAdapter>::Err>

Get the cached value of the Voltage property, or None if the property is not cached.

pub fn receive_voltage_changed(
    &self
) -> PropertyIterator<'c, <Result<f64> as ResultAdapter>::Ok>

Create a stream for the Voltage property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

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

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 fn introspect(&self) -> 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>, 

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 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 fn get_property<T>(&self, property_name: &str) -> 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 or call the Get method of the org.freedesktop.DBus.Properties interface.

pub fn set_property<'t, T>(
    &self,
    property_name: &str,
    value: T
) -> 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 fn call_method<'m, M, B>(
    &self,
    method_name: M,
    body: &B
) -> Result<Arc<Message>, Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

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, Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    R: DeserializeOwned + Type,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

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<(), Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

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, M>(
    &self,
    signal_name: M
) -> Result<SignalIterator<'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.

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_all_signals(&self) -> Result<SignalIterator<'a>, Error>

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, T>(
    &self,
    name: &'name str
) -> PropertyIterator<'a, T> where
    'name: 'a, 

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.

pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>

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.

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

Get a reference to the underlying async Proxy.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'c> Clone for DeviceProxyBlocking<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for DeviceProxyBlocking<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for DeviceProxyBlocking<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for DeviceProxyBlocking<'c>

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

Mutably dereferences the value.

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

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

Performs the conversion.

impl<'a> ProxyDefault for DeviceProxyBlocking<'a>

const INTERFACE: &'static str

const DESTINATION: &'static str

const PATH: &'static str

impl<'c> Serialize for DeviceProxyBlocking<'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 DeviceProxyBlocking<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.