Struct upower_dbus::UPowerProxyBlocking
source · pub struct UPowerProxyBlocking<'c>(_);
Implementations§
source§impl<'c> UPowerProxyBlocking<'c>
impl<'c> UPowerProxyBlocking<'c>
sourcepub fn new(conn: &Connection) -> Result<UPowerProxyBlocking<'c>>
pub fn new(conn: &Connection) -> Result<UPowerProxyBlocking<'c>>
Creates a new proxy with the default service and path.
sourcepub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
Returns a customizable builder for this proxy.
sourcepub fn into_inner(self) -> Proxy<'c>
pub fn into_inner(self) -> Proxy<'c>
Consumes self
, returning the underlying zbus::Proxy
.
sourcepub fn enumerate_devices(&self) -> Result<Vec<OwnedObjectPath>>
pub fn enumerate_devices(&self) -> Result<Vec<OwnedObjectPath>>
EnumerateDevices method
sourcepub fn get_critical_action(&self) -> Result<String>
pub fn get_critical_action(&self) -> Result<String>
GetCriticalAction method
sourcepub fn get_display_device(&self) -> Result<DeviceProxyBlocking<'c>>
pub fn get_display_device(&self) -> Result<DeviceProxyBlocking<'c>>
GetDisplayDevice method
sourcepub fn receive_device_added(&self) -> Result<DeviceAddedIterator<'c>>
pub fn receive_device_added(&self) -> Result<DeviceAddedIterator<'c>>
Create a stream that receives DeviceAdded
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
DeviceAdded signal
sourcepub fn receive_device_added_with_args(
&self,
args: &[(u8, &str)]
) -> Result<DeviceAddedIterator<'c>>
pub fn receive_device_added_with_args(
&self,
args: &[(u8, &str)]
) -> Result<DeviceAddedIterator<'c>>
Create a stream that receives DeviceAdded
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal_with_args
.
DeviceAdded signal
sourcepub fn receive_device_removed(&self) -> Result<DeviceRemovedIterator<'c>>
pub fn receive_device_removed(&self) -> Result<DeviceRemovedIterator<'c>>
Create a stream that receives DeviceRemoved
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
DeviceRemoved signal
sourcepub fn receive_device_removed_with_args(
&self,
args: &[(u8, &str)]
) -> Result<DeviceRemovedIterator<'c>>
pub fn receive_device_removed_with_args(
&self,
args: &[(u8, &str)]
) -> Result<DeviceRemovedIterator<'c>>
Create a stream that receives DeviceRemoved
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal_with_args
.
DeviceRemoved signal
sourcepub fn daemon_version(&self) -> Result<String>
pub fn daemon_version(&self) -> Result<String>
DaemonVersion property
sourcepub fn cached_daemon_version(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
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.
sourcepub fn receive_daemon_version_changed(
&self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
pub fn receive_daemon_version_changed(
&self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the DaemonVersion
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
sourcepub fn lid_is_closed(&self) -> Result<bool>
pub fn lid_is_closed(&self) -> Result<bool>
LidIsClosed property
sourcepub fn cached_lid_is_closed(
&self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
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.
sourcepub fn receive_lid_is_closed_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_lid_is_closed_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the LidIsClosed
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
sourcepub fn lid_is_present(&self) -> Result<bool>
pub fn lid_is_present(&self) -> Result<bool>
LidIsPresent property
sourcepub fn cached_lid_is_present(
&self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
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.
sourcepub fn receive_lid_is_present_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_lid_is_present_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the LidIsPresent
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
sourcepub fn on_battery(&self) -> Result<bool>
pub fn on_battery(&self) -> Result<bool>
OnBattery property
sourcepub fn cached_on_battery(
&self
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
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.
sourcepub fn receive_on_battery_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_on_battery_changed(
&self
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the OnBattery
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Methods from Deref<Target = Proxy<'c>>§
sourcepub fn connection(&self) -> &Connection
pub fn connection(&self) -> &Connection
Get a reference to the associated connection.
sourcepub fn destination(&self) -> &BusName<'_>
pub fn destination(&self) -> &BusName<'_>
Get a reference to the destination service name.
sourcepub fn introspect(&self) -> Result<String, Error>
pub fn introspect(&self) -> Result<String, Error>
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
sourcepub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
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.
sourcepub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>
pub fn cached_property_raw<'p>(
&'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.
sourcepub fn get_property<T>(&self, property_name: &str) -> Result<T, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
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.
sourcepub fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> Result<(), Error>where
T: 't + Into<Value<'t>>,
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.
sourcepub fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<Arc<Message>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<Arc<Message>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'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).
sourcepub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'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.
sourcepub fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>,
body: &B
) -> Result<Option<R>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>,
body: &B
) -> Result<Option<R>, Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
Call a method and return the reply body, optionally supplying a set of method flags to control the way the method call message is sent and handled.
Use call
instead if you do not need any special handling via additional flags.
If the NoReplyExpected
flag is passed , this will return None immediately
after sending the message, similar to call_noreply
sourcepub fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<(), Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> Result<(), Error>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
Call a method without expecting a reply
This sets the NoReplyExpected
flag on the calling message and does not wait for a reply.
sourcepub 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>,
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).
sourcepub fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)]
) -> Result<SignalIterator<'a>, Error>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)]
) -> Result<SignalIterator<'a>, Error>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
Same as Proxy::receive_signal
but with a filter.
The D-Bus specification allows you to filter signals by their arguments, which helps avoid a lot of unnecessary traffic and processing since the filter is run on the server side. Use this method where possible. Note that this filtering is limited to arguments of string types.
The arguments are passed as a tuples of argument index and expected value.
sourcepub fn receive_all_signals(&self) -> Result<SignalIterator<'a>, Error>
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).
sourcepub fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> PropertyIterator<'a, T>where
'name: 'a,
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.
sourcepub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>
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.
Trait Implementations§
source§impl<'c> AsMut<Proxy<'c>> for UPowerProxyBlocking<'c>
impl<'c> AsMut<Proxy<'c>> for UPowerProxyBlocking<'c>
source§impl<'c> AsRef<Proxy<'c>> for UPowerProxyBlocking<'c>
impl<'c> AsRef<Proxy<'c>> for UPowerProxyBlocking<'c>
source§impl<'c> Clone for UPowerProxyBlocking<'c>
impl<'c> Clone for UPowerProxyBlocking<'c>
source§fn clone(&self) -> UPowerProxyBlocking<'c>
fn clone(&self) -> UPowerProxyBlocking<'c>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more