Struct ashpd::desktop::game_mode::GameMode

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

The interface lets sandboxed applications access GameMode from within the sandbox.

It is analogous to the com.feralinteractive.GameMode interface and will proxy request there, but with additional permission checking and pid mapping. The latter is necessary in the case that sandbox has pid namespace isolation enabled. See the man page for pid_namespaces(7) for more details, but briefly, it means that the sandbox has its own process id namespace which is separated from the one on the host. Thus there will be two separate process ids (pids) within two different namespaces that both identify same process. One id from the pid namespace inside the sandbox and one id from the host pid namespace. Since GameMode expects pids from the host pid namespace but programs inside the sandbox can only know pids from the sandbox namespace, process ids need to be translated from the portal to the host namespace. The portal will do that transparently for all calls where this is necessary.

Note: GameMode will monitor active clients, i.e. games and other programs that have successfully called GameMode::register. In the event that a client terminates without a call to the GameMode::unregister method, GameMode will automatically un-register the client. This might happen with a (small) delay.

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

Implementations

impl<'a> GameMode<'a>

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

Create a new instance of GameMode.

pub async fn query_status(&self, pid: u32) -> Result<Status, Error>

Query the GameMode status for a process. If the caller is running inside a sandbox with pid namespace isolation, the pid will be translated to the respective host pid.

Arguments

• pid - Process id to query the GameMode status of.

Specifications

See also QueryStatus.

pub async fn query_status_by_pidfd( &self, target: &BorrowedFd<'_>, requester: &BorrowedFd<'_>, ) -> Result<Status, Error>

Query the GameMode status for a process.

Arguments

• target - Pid file descriptor to query the GameMode status of.
• requester - Pid file descriptor of the process requesting the information.

Specifications

See also QueryStatusByPIDFd.

pub async fn query_status_by_pid( &self, target: u32, requester: u32, ) -> Result<Status, Error>

Query the GameMode status for a process.

Arguments

• target - Process id to query the GameMode status of.
• requester - Process id of the process requesting the information.

Specifications

See also QueryStatusByPid.

pub async fn register(&self, pid: u32) -> Result<(), Error>

Register a game with GameMode and thus request GameMode to be activated. If the caller is running inside a sandbox with pid namespace isolation, the pid will be translated to the respective host pid. See the general introduction for details. If the GameMode has already been requested for pid before, this call will fail.

Arguments

• pid - Process id of the game to register.

Specifications

See also RegisterGame.

pub async fn register_by_pidfd( &self, target: &BorrowedFd<'_>, requester: &BorrowedFd<'_>, ) -> Result<(), Error>

Register a game with GameMode.

Arguments

• target - Process file descriptor of the game to register.
• requester - Process file descriptor of the process requesting the registration.

Specifications

See also RegisterGameByPIDFd.

pub async fn register_by_pid( &self, target: u32, requester: u32, ) -> Result<(), Error>

Register a game with GameMode.

Arguments

• target - Process id of the game to register.
• requester - Process id of the process requesting the registration.

Specifications

See also RegisterGameByPid.

pub async fn unregister(&self, pid: u32) -> Result<(), Error>

Un-register a game from GameMode. if the call is successful and there are no other games or clients registered, GameMode will be deactivated. If the caller is running inside a sandbox with pid namespace isolation, the pid will be translated to the respective host pid.

Arguments

• pid - Process id of the game to un-register.

Specifications

See also UnregisterGame.

pub async fn unregister_by_pidfd( &self, target: &BorrowedFd<'_>, requester: &BorrowedFd<'_>, ) -> Result<(), Error>

Un-register a game from GameMode.

Arguments

• target - Pid file descriptor of the game to un-register.
• requester - Pid file descriptor of the process requesting the un-registration.

Specifications

See also UnregisterGameByPIDFd.

pub async fn unregister_by_pid( &self, target: u32, requester: u32, ) -> Result<(), Error>

Un-register a game from GameMode.

Arguments

• target - Process id of the game to un-register.
• requester - Process id of the process requesting the un-registration.

Specifications

See also UnregisterGameByPid.

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 GameMode<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for GameMode<'a>

type Target = Proxy<'a>

The resulting type after dereferencing.

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

Dereferences the value.