Enum Request 

#[non_exhaustive]
pub enum Request {
    Destroy,
    GetSession {
        id: New<XdgSessionV1>,
        reason: Reason,
        session_id: Option<String>,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

Destroy this object

Destroy the manager object. The existing session objects will be unaffected.

This is a destructor, once received this object cannot be used any longer.

GetSession

create or restore a session

Create a session object corresponding to either an existing session identified by the given session identifier string or a new session. While the session object exists, the session is considered to be “in use”.

If an identifier string represents a session that is currently actively in use by the the same client, an ‘in_use’ error is raised. If some other client is currently using the same session, the new session will replace managing the associated state.

If the reason is not a valid enum entry, the ‘invalid_reason’ protocol error is raised.

NULL is passed to initiate a new session. If a session_id is passed which does not represent a valid session, the compositor treats it as if NULL had been passed.

The session id string must be UTF-8 encoded. It is also limited by the maximum length of wayland messages (around 4KB). The ‘invalid_session_id’ protocol error will be raised if an invalid string is provided.

A client is allowed to have any number of in use sessions at the same time.

Fields

id: New<XdgSessionV1>

reason: Reason

reason for session

session_id: Option<String>

the session to restore

Implementations

impl Request

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.