Struct wayland_client::protocol::wl_display::WlDisplay

pub struct WlDisplay { /* private fields */ }

core global object

The core global object. This is a special singleton object. It is used for internal Wayland protocol features.

See also the Event enum for this interface.

Implementations

impl WlDisplay

pub fn sync<U: Send + Sync + 'static, D: Dispatch<WlCallback, U> + 'static>(
    &self,
    qh: &QueueHandle<D>,
    udata: U
) -> Result<WlCallback, InvalidId>

asynchronous roundtrip

The sync request asks the server to emit the ‘done’ event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is the event serial.

pub fn get_registry<U: Send + Sync + 'static, D: Dispatch<WlRegistry, U> + 'static>(
    &self,
    qh: &QueueHandle<D>,
    udata: U
) -> Result<WlRegistry, InvalidId>

get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor.

It should be noted that the server side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke get_registry as infrequently as possible to avoid wasting memory.

Trait Implementations

impl Clone for WlDisplay

fn clone(&self) -> WlDisplay

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WlDisplay

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

Formats the value using the given formatter.

impl PartialEq<WlDisplay> for WlDisplay

fn eq(&self, other: &WlDisplay) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Proxy for WlDisplay

type Request = Request

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>(
    &self,
    req: Self::Request,
    data: Arc<dyn ObjectData>
) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn parse_event(
    conn: &Connection,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request(
    &self,
    conn: &Connection,
    msg: Self::Request
) -> Result<(Message<ObjectId>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

impl Eq for WlDisplay