Struct atspi::events::window::WindowProxy
source · pub struct WindowProxy<'c>(_);Implementations
sourceimpl<'c> WindowProxy<'c>
impl<'c> WindowProxy<'c>
sourcepub async fn new(conn: &Connection) -> Result<WindowProxy<'c>>
pub async fn new(conn: &Connection) -> Result<WindowProxy<'c>>
Creates a new proxy with the default service & 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 async fn receive_activate(&self) -> Result<ActivateStream<'c>>
pub async fn receive_activate(&self) -> Result<ActivateStream<'c>>
Create a stream that receives Activate signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Activate signal
sourcepub async fn receive_close(&self) -> Result<CloseStream<'c>>
pub async fn receive_close(&self) -> Result<CloseStream<'c>>
Create a stream that receives Close signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Close signal
sourcepub async fn receive_create(&self) -> Result<CreateStream<'c>>
pub async fn receive_create(&self) -> Result<CreateStream<'c>>
Create a stream that receives Create signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Create signal
sourcepub async fn receive_deactivate(&self) -> Result<DeactivateStream<'c>>
pub async fn receive_deactivate(&self) -> Result<DeactivateStream<'c>>
Create a stream that receives Deactivate signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Deactivate signal
sourcepub async fn receive_desktop_create(&self) -> Result<DesktopCreateStream<'c>>
pub async fn receive_desktop_create(&self) -> Result<DesktopCreateStream<'c>>
Create a stream that receives DesktopCreate signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
DesktopCreate signal
sourcepub async fn receive_desktop_destroy(&self) -> Result<DesktopDestroyStream<'c>>
pub async fn receive_desktop_destroy(&self) -> Result<DesktopDestroyStream<'c>>
Create a stream that receives DesktopDestroy signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
DesktopDestroy signal
sourcepub async fn receive_destroy(&self) -> Result<DestroyStream<'c>>
pub async fn receive_destroy(&self) -> Result<DestroyStream<'c>>
Create a stream that receives Destroy signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Destroy signal
sourcepub async fn receive_lower(&self) -> Result<LowerStream<'c>>
pub async fn receive_lower(&self) -> Result<LowerStream<'c>>
Create a stream that receives Lower signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Lower signal
sourcepub async fn receive_maximize(&self) -> Result<MaximizeStream<'c>>
pub async fn receive_maximize(&self) -> Result<MaximizeStream<'c>>
Create a stream that receives Maximize signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Maximize signal
sourcepub async fn receive_minimize(&self) -> Result<MinimizeStream<'c>>
pub async fn receive_minimize(&self) -> Result<MinimizeStream<'c>>
Create a stream that receives Minimize signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Minimize signal
sourcepub async fn receive_move_(&self) -> Result<MoveStream<'c>>
pub async fn receive_move_(&self) -> Result<MoveStream<'c>>
Create a stream that receives Move signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Move signal
sourcepub async fn receive_property_change(&self) -> Result<PropertyChangeStream<'c>>
pub async fn receive_property_change(&self) -> Result<PropertyChangeStream<'c>>
Create a stream that receives PropertyChange signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
PropertyChange signal
sourcepub async fn receive_raise(&self) -> Result<RaiseStream<'c>>
pub async fn receive_raise(&self) -> Result<RaiseStream<'c>>
Create a stream that receives Raise signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Raise signal
sourcepub async fn receive_reparent(&self) -> Result<ReparentStream<'c>>
pub async fn receive_reparent(&self) -> Result<ReparentStream<'c>>
Create a stream that receives Reparent signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Reparent signal
sourcepub async fn receive_resize(&self) -> Result<ResizeStream<'c>>
pub async fn receive_resize(&self) -> Result<ResizeStream<'c>>
Create a stream that receives Resize signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Resize signal
sourcepub async fn receive_restore(&self) -> Result<RestoreStream<'c>>
pub async fn receive_restore(&self) -> Result<RestoreStream<'c>>
Create a stream that receives Restore signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Restore signal
sourcepub async fn receive_restyle(&self) -> Result<RestyleStream<'c>>
pub async fn receive_restyle(&self) -> Result<RestyleStream<'c>>
Create a stream that receives Restyle signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Restyle signal
sourcepub async fn receive_shade(&self) -> Result<ShadeStream<'c>>
pub async fn receive_shade(&self) -> Result<ShadeStream<'c>>
Create a stream that receives Shade signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
Shade signal
sourcepub async fn receive_u_ushade(&self) -> Result<UUshadeStream<'c>>
pub async fn receive_u_ushade(&self) -> Result<UUshadeStream<'c>>
Create a stream that receives UUshade signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
uUshade signal
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 async fn introspect(&self) -> impl Future<Output = Result<String, Error>>
pub async fn introspect(&self) -> impl Future<Output = 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 self,
property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>
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.
sourcepub async fn get_property<T>(
&self,
property_name: &str
) -> impl Future<Output = Result<T, Error>>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
pub async fn get_property<T>(
&self,
property_name: &str
) -> impl Future<Output = 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) or call the
Get method of the org.freedesktop.DBus.Properties interface.
sourcepub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = Result<(), Error>>where
T: 't + Into<Value<'t>>,
pub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = 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 async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<Arc<Message>, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<R, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<(), Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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 async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = 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.
sourcepub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
pub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
Create a stream for all signals emitted by this service.
sourcepub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = PropertyStream<'a, T>>where
'name: 'a,
pub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = 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.
sourcepub async fn receive_owner_changed(
&self
) -> impl Future<Output = Result<OwnerChangedStream<'_>, Error>>
pub async fn receive_owner_changed(
&self
) -> impl Future<Output = 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
sourceimpl<'c> AsMut<Proxy<'c>> for WindowProxy<'c>
impl<'c> AsMut<Proxy<'c>> for WindowProxy<'c>
sourceimpl<'c> AsRef<Proxy<'c>> for WindowProxy<'c>
impl<'c> AsRef<Proxy<'c>> for WindowProxy<'c>
sourceimpl<'c> Clone for WindowProxy<'c>
impl<'c> Clone for WindowProxy<'c>
sourcefn clone(&self) -> WindowProxy<'c>
fn clone(&self) -> WindowProxy<'c>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more