Enum Request

#[non_exhaustive]
pub enum Request<'a> {
    Destroy,
    Ring {
        surface: Option<WlSurface>,
    },
}

Available on crate features staging and 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 system bell object

Notify that the object will no longer be used.

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

Ring

ring the system bell

This requests rings the system bell on behalf of a client. How ringing the bell is implemented is up to the compositor. It may be an audible sound, a visual feedback of some kind, or any other thing including nothing.

The passed surface should correspond to a toplevel like surface role, or be null, meaning the client doesn’t have a particular toplevel it wants to associate the bell ringing with. See the xdg-shell protocol extension for a toplevel like surface role.

Fields

surface: Option<WlSurface>

associated surface

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.