Enum Request

#[non_exhaustive]
pub enum Request<'a> {
    Destroy,
    SetName {
        icon_name: String,
    },
    AddBuffer {
        buffer: WlBuffer,
        scale: i32,
    },
}

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 icon object

Destroys the ‘xdg_toplevel_icon_v1’ object. The icon must still remain set on every toplevel it was assigned to, until the toplevel icon is reset explicitly.

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

SetName

set an icon name

This request assigns an icon name to this icon. Any previously set name is overridden.

The compositor must resolve ‘icon_name’ according to the lookup rules described in the XDG icon theme specification1 using the environment’s current icon theme.

If the compositor does not support icon names or cannot resolve ‘icon_name’ according to the XDG icon theme specification it must fall back to using pixel buffer data instead.

If this request is made after the icon has been assigned to a toplevel via ‘set_icon’, a ‘immutable’ error must be raised.

Fields

icon_name: String

AddBuffer

add icon data from a pixel buffer

This request adds pixel data supplied as wl_buffer to the icon.

The client should add pixel data for all icon sizes and scales that it can provide, or which are explicitly requested by the compositor via ‘icon_size’ events on xdg_toplevel_icon_manager_v1.

The wl_buffer supplying pixel data as ‘buffer’ must be backed by wl_shm and must be a square (width and height being equal). If any of these buffer requirements are not fulfilled, a ‘invalid_buffer’ error must be raised.

If this icon instance already has a buffer of the same size and scale from a previous ‘add_buffer’ request, data from the last request overrides the preexisting pixel data.

The wl_buffer must be kept alive for as long as the xdg_toplevel_icon it is associated with is not destroyed, otherwise a ‘no_buffer’ error is raised. The buffer contents must not be modified after it was assigned to the icon. As a result, the region of the wl_shm_pool’s backing storage used for the wl_buffer must not be modified after this request is sent. The wl_buffer.release event is unused.

If this request is made after the icon has been assigned to a toplevel via ‘set_icon’, a ‘immutable’ error must be raised.

Fields

buffer: WlBuffer

scale: i32

the scaling factor of the icon, e.g. 1

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.