Enum wayland_protocols::xdg_shell::client::xdg_wm_base::Request

#[non_exhaustive]
pub enum Request {
    Destroy,
    CreatePositioner {},
    GetXdgSurface {
        surface: WlSurface,
    },
    Pong {
        serial: u32,
    },
}

Variants (Non-exhaustive)

[+] This enum is marked as 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

[−] Expand description

destroy xdg_wm_base

Destroy this xdg_wm_base object.

Destroying a bound xdg_wm_base object while there are surfaces still alive created by this xdg_wm_base object instance is illegal and will result in a protocol error.

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

CreatePositioner

[−] Expand description

create a positioner object

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

[−] Show fields

Fields of CreatePositioner

GetXdgSurface

[−] Expand description

create a shell surface from a surface

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

[−] Show fields

Fields of GetXdgSurface

surface: WlSurface

Pong

[−] Expand description

respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg_wm_base.ping.

[−] Show fields

Fields of Pong

serial: u32

Trait Implementations

impl Debug for Request[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl MessageGroup for Request[+]

[+] Show hidden undocumented items

const MESSAGES: &'static [MessageDesc][−][−]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool[−]

Whether this message is a destructor

fn opcode(&self) -> u16[−]

The opcode of this message

fn since(&self) -> u32[−]

The minimal object version for which this message exists

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>[−]

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>[−]

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message[−]

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>[−]

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, [−]

Build a C representation of this message