Struct wayland_client::wayland::WlRegistry

pub struct WlRegistry {
    // some fields omitted
}

global registry object

The global registry object. The server has a number of global objects that are available to all clients. These objects typically represent an actual object in the server (for example, an input device) or they are singleton objects that provide extension functionality.

When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device or monitor hotplugs, reconfiguration or other events, and the registry will send out global and global_remove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the wl_display.sync request immediately after calling wl_display.get_registry.

A client can bind to a global object by using the bind request. This creates a client-side handle that lets the object emit events to the client and lets the client invoke requests on the object.

Methods

impl WlRegistry

unsafe fn bind<T: Proxy>(&self, name: u32, version: u32) -> T

bind an object to the display

Binds a new, client-created object to the server using the specified name as the identifier.

Trait Implementations

impl Sync for WlRegistry

impl Send for WlRegistry

impl Proxy for WlRegistry

fn ptr(&self) -> *mut wl_proxy

fn interface() -> *mut wl_interface

fn interface_name() -> &'static str

The internal name of this interface, as advertized by the registry if it is a global.

fn version() -> u32

The maximum version of this interface handled by the library.

fn id(&self) -> ProxyId

Get the id of this proxy

unsafe fn from_ptr(ptr: *mut wl_proxy) -> WlRegistry

Creates a proxy from a fresh ptr

unsafe fn from_ptr_no_own(ptr: *mut wl_proxy) -> WlRegistry

Creates a proxy from a ptr that is managed elsewhere

fn set_evt_iterator(&mut self, evt: &EventIterator)

Set the event iterator associated to this proxy

impl Debug for WlRegistry

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for WlRegistry

fn drop(&mut self)

A method called when the value goes out of scope.