Struct Client

pub struct Client { /* private fields */ }

A struct representing a Wayland client connected to your compositor.

Implementations

impl Client

pub fn id(&self) -> ClientId

The backend ClientId of this client

pub fn get_data<Data: ClientData + 'static>(&self) -> Option<&Data>

Access the data associated to this client

Returns None if the provided Data type parameter is not the correct one.

pub fn get_credentials( &self, handle: &DisplayHandle, ) -> Result<Credentials, InvalidId>

Access the pid/uid/gid of this client

Note: You should be careful if you plan tu use this for security purposes, as it is possible for programs to spoof this kind of information.

For a discussion about the subject of securely identifying clients, see https://gitlab.freedesktop.org/wayland/weston/-/issues/206

pub fn create_resource<I: Resource + 'static, U: Send + Sync + 'static, D: Dispatch<I, U> + 'static>( &self, handle: &DisplayHandle, version: u32, user_data: U, ) -> Result<I, InvalidId>

Create a new Wayland object in the protocol state of this client

The newly created resource should be immediately sent to the client through an associated event with a new_id argument. Not doing so risks corrupting the protocol state and causing protocol errors at a later time.

pub fn create_resource_from_objdata<I: Resource + 'static, D: 'static>( &self, handle: &DisplayHandle, version: u32, obj_data: Arc<dyn ObjectData<D>>, ) -> Result<I, InvalidId>

Create a new Wayland object in the protocol state of this client, from an ObjectData

This is a lower-level method than create_resource(), in case you need to bypass the Dispatch machinery.

The newly created resource should be immediately sent to the client through an associated event with a new_id argument. Not doing so risks corrupting the protocol state and causing protocol errors at a later time.

pub fn object_from_protocol_id<I: Resource + 'static>( &self, handle: &DisplayHandle, protocol_id: u32, ) -> Result<I, InvalidId>

Attempt to retrieve an object from this client’s protocol state from its protocol id

Will fail if either the provided protocol id does not correspond to any object, or if the corresponding object is not of the interface I.

pub fn kill(&self, handle: &DisplayHandle, error: ProtocolError)

Kill this client by triggering a protocol error

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl PartialEq for Client

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.