Enum Request

#[non_exhaustive]
pub enum Request<'a> {
    Destroy,
    Remove,
    AddToplevel {
        toplevel: XdgToplevel,
        name: String,
    },
    RestoreToplevel {
        toplevel: XdgToplevel,
        name: String,
    },
}

Available on crate feature client only.

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 the session

Destroy a session object, preserving the current state but not continuing to make further updates if state changes occur. This makes the associated xx_toplevel_session_v1 objects inert.

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

Remove

Remove the session

Remove the session, making it no longer available for restoration. A compositor should in response to this request remove the data related to this session from its storage.

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

AddToplevel

add a new surface to the session

Attempt to add a given surface to the session. The passed name is used to identify what window is being restored, and may be used store window specific state within the session.

Calling this with a toplevel that is already managed by the session with the same associated will raise an in_use error.

Fields

toplevel: XdgToplevel

name: String

RestoreToplevel

restore a surface state

Inform the compositor that the toplevel associated with the passed name should have its window management state restored.

Calling this with a toplevel that is already managed by the session with the same associated will raise an in_use error.

This request must be called prior to the first commit on the associated wl_surface, otherwise an already_mapped error is raised.

As part of the initial configure sequence, if the toplevel was successfully restored, a xx_toplevel_session_v1.restored event is emitted. See the xx_toplevel_session_v1.restored event for further details.

Fields

toplevel: XdgToplevel

name: String

Implementations

impl<'a> Request<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.