Struct wayland_client::globals::GlobalList

pub struct GlobalList { /* private fields */ }

A helper to retrieve a list of globals and bind them

The GlobalList can be used as a Dispatch target for the wl_registry. It maintains a list of globals advertized by the compositor, and provides a way to bind according to specified version requirements. It is an easy way to ensure at startup that the server advertized all the globals your app needs, and bind them all at once.

Implementations

impl GlobalList

pub fn new() -> GlobalList

Create a new GLobalList

pub fn list(&self) -> &[GlobalDescription]

Access the list of currently advertized globals

pub fn bind<I: Proxy + 'static, D: Dispatch<I> + 'static>(
    &self,
    conn: &mut ConnectionHandle<'_>,
    qh: &QueueHandle<D>,
    registry: &WlRegistry,
    version: Range<u32>,
    user_data: <D as Dispatch<I>>::UserData
) -> Result<I, BindError>

Bind a global

You can specify the requested interface as type parameter, and the version range. You also need to provide the user data value that will be set for the newly created object.

Trait Implementations

impl AsMut<GlobalList> for GlobalList

fn as_mut(&mut self) -> &mut GlobalList

Performs the conversion.

impl Debug for GlobalList

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

Formats the value using the given formatter.

impl Default for GlobalList

fn default() -> Self

Returns the “default value” for a type.

impl<D> DelegateDispatch<WlRegistry, D> for GlobalList where
    D: Dispatch<WlRegistry, UserData = ()> + AsMut<GlobalList>, 

fn event(
    handle: &mut D,
    _: &WlRegistry,
    event: Event,
    _: &(),
    _: &mut ConnectionHandle<'_>,
    _: &QueueHandle<D>
)

Called when an event from the server is processed.

fn event_created_child(
    opcode: u16,
    _qhandle: &QueueHandle<D>
) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl DelegateDispatchBase<WlRegistry> for GlobalList

type UserData = ()

The type of user data the delegate holds

impl Dispatch<WlRegistry> for GlobalList

type UserData = ()

The user data associated with the type of proxy.

fn event(
    &mut self,
    proxy: &WlRegistry,
    event: Event,
    data: &Self::UserData,
    connhandle: &mut ConnectionHandle<'_>,
    qhandle: &QueueHandle<Self>
)

Called when an event from the server is processed.

fn event_created_child(
    opcode: u16,
    _qhandle: &QueueHandle<Self>
) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events