Struct ashpd::desktop::remote_desktop::RemoteDesktop

pub struct RemoteDesktop<'a>(/* private fields */);

The interface lets sandboxed applications create remote desktop sessions.

Wrapper of the DBus interface: org.freedesktop.portal.RemoteDesktop.

Implementations

impl<'a> RemoteDesktop<'a>

pub async fn new() -> Result<RemoteDesktop<'a>, Error>

Create a new instance of RemoteDesktop.

pub async fn create_session(&self) -> Result<Session<'a, Self>, Error>

Create a remote desktop session. A remote desktop session is used to allow remote controlling a desktop session. It can also be used together with a screen cast session.

Specifications

See also CreateSession.

pub async fn select_devices( &self, session: &Session<'_, Self>, types: BitFlags<DeviceType>, restore_token: Option<&str>, persist_mode: PersistMode, ) -> Result<Request<()>, Error>

Select input devices to remote control.

Arguments

• session - A Session, created with create_session().
• types - The device types to request remote controlling of.

Specifications

See also SelectDevices.

pub async fn start( &self, session: &Session<'_, Self>, identifier: &WindowIdentifier, ) -> Result<Request<SelectedDevices>, Error>

Start the remote desktop session.

This will typically result in the portal presenting a dialog letting the user select what to share, including devices and optionally screen content if screen cast sources was selected.

Arguments

• session - A Session, created with create_session().
• identifier - The application window identifier.

Specifications

See also Start.

pub async fn notify_keyboard_keycode( &self, session: &Session<'_, Self>, keycode: i32, state: KeyState, ) -> Result<(), Error>

Notify keyboard code.

Note only works if DeviceType::Keyboard access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• keycode - Keyboard code that was pressed or released.
• state - The new state of the keyboard code.

Specifications

See also NotifyKeyboardKeycode.

pub async fn notify_keyboard_keysym( &self, session: &Session<'_, Self>, keysym: i32, state: KeyState, ) -> Result<(), Error>

Notify keyboard symbol.

Note only works if DeviceType::Keyboard access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• keysym - Keyboard symbol that was pressed or released.
• state - The new state of the keyboard code.

Specifications

See also NotifyKeyboardKeysym.

pub async fn notify_touch_up( &self, session: &Session<'_, Self>, slot: u32, ) -> Result<(), Error>

Notify about a new touch up event.

Note only works if DeviceType::Touchscreen access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• slot - Touch slot where touch point appeared.

Specifications

See also NotifyTouchUp.

pub async fn notify_touch_down( &self, session: &Session<'_, Self>, stream: u32, slot: u32, x: f64, y: f64, ) -> Result<(), Error>

Notify about a new touch down event. The (x, y) position represents the new touch point position in the streams logical coordinate space.

Note only works if DeviceType::Touchscreen access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• stream - The PipeWire stream node the coordinate is relative to.
• slot - Touch slot where touch point appeared.
• x - Touch down x coordinate.
• y - Touch down y coordinate.

Specifications

See also NotifyTouchDown.

pub async fn notify_touch_motion( &self, session: &Session<'_, Self>, stream: u32, slot: u32, x: f64, y: f64, ) -> Result<(), Error>

Notify about a new touch motion event. The (x, y) position represents where the touch point position in the streams logical coordinate space moved.

Note only works if DeviceType::Touchscreen access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• stream - The PipeWire stream node the coordinate is relative to.
• slot - Touch slot where touch point appeared.
• x - Touch motion x coordinate.
• y - Touch motion y coordinate.

Specifications

See also NotifyTouchMotion.

pub async fn notify_pointer_motion_absolute( &self, session: &Session<'_, Self>, stream: u32, x: f64, y: f64, ) -> Result<(), Error>

Notify about a new absolute pointer motion event. The (x, y) position represents the new pointer position in the streams logical coordinate space.

Arguments

• session - A Session, created with create_session().
• stream - The PipeWire stream node the coordinate is relative to.
• x - Pointer motion x coordinate.
• y - Pointer motion y coordinate.

Specifications

See also NotifyPointerMotionAbsolute.

pub async fn notify_pointer_motion( &self, session: &Session<'_, Self>, dx: f64, dy: f64, ) -> Result<(), Error>

Notify about a new relative pointer motion event. The (dx, dy) vector represents the new pointer position in the streams logical coordinate space.

Arguments

• session - A Session, created with create_session().
• dx - Relative movement on the x axis.
• dy - Relative movement on the y axis.

Specifications

See also NotifyPointerMotion.

pub async fn notify_pointer_button( &self, session: &Session<'_, Self>, button: i32, state: KeyState, ) -> Result<(), Error>

Notify pointer button. The pointer button is encoded according to Linux Evdev button codes.

Note only works if DeviceType::Pointer access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• button - The pointer button was pressed or released.
• state - The new state of the keyboard code.

Specifications

See also NotifyPointerButton.

pub async fn notify_pointer_axis_discrete( &self, session: &Session<'_, Self>, axis: Axis, steps: i32, ) -> Result<(), Error>

Notify pointer axis discrete.

Note only works if DeviceType::Pointer access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• axis - The axis that was scrolled.

Specifications

See also NotifyPointerAxisDiscrete.

pub async fn notify_pointer_axis( &self, session: &Session<'_, Self>, dx: f64, dy: f64, finish: bool, ) -> Result<(), Error>

Notify pointer axis. The axis movement from a “smooth scroll” device, such as a touchpad. When applicable, the size of the motion delta should be equivalent to the motion vector of a pointer motion done using the same advice.

Note only works if DeviceType::Pointer access was provided after starting the session.

Arguments

• session - A Session, created with create_session().
• dx - Relative axis movement on the x axis.
• dy - Relative axis movement on the y axis.
• finish - Whether it is the last axis event.

Specifications

See also NotifyPointerAxis.

pub async fn connect_to_eis( &self, session: &Session<'_, Self>, ) -> Result<OwnedFd, Error>

Connect to EIS.

Note only succeeds if called after RemoteDesktop::start.

Requires RemoteDesktop version 2.

Arguments

• session - A Session, created with create_session().

Required version

The method requires the 2nd version implementation of the portal and would fail with Error::RequiresVersion otherwise.

Specifications

See also ConnectToEIS.

pub async fn available_device_types( &self, ) -> Result<BitFlags<DeviceType>, Error>

Available source types.

Specifications

See also AvailableDeviceTypes.

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

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>( &'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) 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<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).

pub async 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: for<'d> DynamicDeserialize<'d>,

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_with_flags<'m, M, B, R>( &self, method_name: M, flags: BitFlags<MethodFlags>, body: &B, ) -> Result<Option<R>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType, R: for<'d> DynamicDeserialize<'d>,

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

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

pub async fn receive_signal<'m, M>( &self, signal_name: M, ) -> Result<SignalStream<'m>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

pub async fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> Result<SignalStream<'m>, Error>

where 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.

pub async fn receive_all_signals(&self) -> Result<SignalStream<'static>, 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<'a> Debug for RemoteDesktop<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for RemoteDesktop<'a>

type Target = Proxy<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl HasScreencastSession for RemoteDesktop<'_>