Struct upower_dbus::UPowerProxy

pub struct UPowerProxy<'c>(_);

Implementations

impl<'c> UPowerProxy<'c>

pub async fn new(conn: &Connection) -> Result<UPowerProxy<'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 enumerate_devices(&self) -> Result<Vec<OwnedObjectPath>>

EnumerateDevices method

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

GetCriticalAction method

pub async fn get_display_device(&self) -> Result<OwnedObjectPath>

GetDisplayDevice method

pub async fn receive_device_added(&self) -> Result<DeviceAddedStream<'c>>

Create a stream that receives DeviceAdded signals.

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

pub async fn receive_device_removed(&self) -> Result<DeviceRemovedStream<'c>>

Create a stream that receives DeviceRemoved signals.

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

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

DaemonVersion property

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

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

pub async fn receive_daemon_version_changed(
    &self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async fn lid_is_closed(&self) -> Result<bool>

LidIsClosed property

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

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

pub async fn receive_lid_is_closed_changed(
    &self
) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

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

pub async fn lid_is_present(&self) -> Result<bool>

LidIsPresent property

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

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

pub async fn receive_lid_is_present_changed(
    &self
) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

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

pub async fn on_battery(&self) -> Result<bool>

OnBattery property

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

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

pub async fn receive_on_battery_changed(
    &self
) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

Create a stream for the OnBattery property changes. This is a convenient wrapper around zbus::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 async 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 async 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 (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>(
    &'_ 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 async 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 async 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 async 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 async fn receive_signal<'m, M>(
    &'_ self,
    signal_name: M
) -> Result<SignalStream<'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.

pub async fn receive_all_signals(&'_ self) -> Result<SignalStream<'a>, Error>

Create a stream for all signals emitted by this service.

pub async fn receive_property_changed<'name, T>(
    &'_ self,
    name: &'name str
) -> PropertyStream<'a, T> where
    'name: 'a, 

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.

If caching is not enabled on this proxy, the resulting stream will not return any events.

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

Get a stream to receive destination 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.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'c> Clone for UPowerProxy<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for UPowerProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for UPowerProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for UPowerProxy<'c>

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

Mutably dereferences the value.

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

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

Performs the conversion.

impl<'a> ProxyDefault for UPowerProxy<'a>

const INTERFACE: &'static str

const DESTINATION: &'static str

const PATH: &'static str

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

fn signature() -> Signature<'static>

Get the signature for the implementing type.