Struct wayland_server::Client

pub struct Client { /* private fields */ }

A handle to a client connected to your server

There can be several handles referring to the same client.

Implementations

impl Client

pub fn alive(&self) -> bool

Checks whether this client is still connected to the server

pub fn equals(&self, other: &Client) -> bool

Checks whether self and other refer to the same client

pub fn flush(&self)

Flushes the pending events to this client

pub fn kill(&self)

Kills this client

Does nothing if the client is already dead.

pub fn credentials(&self) -> Option<Credentials>

Returns the Credentials from the socket of this client.

The credentials come from getsockopt() with SO_PEERCRED, on the client socket fd.

Be aware that for clients that a compositor forks and execs and then connects using socketpair(), this function will return the credentials for the compositor. The credentials for the socketpair are set at creation time in the compositor.

Returns None if the client is already dead.

pub fn data_map(&self) -> &UserDataMap

Returns a reference to the UserDataMap associated with this client

See UserDataMap documentation for details about its use.

pub fn add_destructor(&self, destructor: Filter<Arc<UserDataMap>>)

Adds a destructor for this client

This filter will be called when the client disconnects or is killed. It has access to the UserDataMap associated with this client.

You can add several destructors which will all be called sequentially. Note that if you accidentally add two copies of the same closure, it will be called twice.

The destructors will be executed on the thread containing the wayland event loop.

Panics: This function will panic if called from an other thread than the one hosting the Display.

pub fn create_resource<I: Interface + From<Resource<I>> + AsRef<Resource<I>>>(
    &self,
    version: u32
) -> Option<Main<I>>

Creates a new resource for this client

To ensure the state coherence between client and server, this resource should immediately be assigned to a filter and sent to the client through an appropriate event. Failure to do so will likely cause protocol errors.

Panics: This function will panic if called from an other thread than the one hosting the Display.

pub fn get_resource<I: Interface + From<Resource<I>> + AsRef<Resource<I>>>(
    &self,
    id: u32
) -> Option<I>

Retrieve a resource of this client for a given id

You need to know in advance which is the interface of this object. If the given id does not correspond to an existing object or the existing object is not of the requested interface, this call returns None.

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<Client> for Client

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Client