Struct WlDisplay 

pub struct WlDisplay { /* private fields */ }

A wl_display object.

See the documentation of the module for the interface description.

Implementations

impl WlDisplay

pub fn set_handler(&self, handler: impl WlDisplayHandler)

Sets a new handler.

pub fn set_boxed_handler(&self, handler: Box<dyn WlDisplayHandler>)

Sets a new, already boxed handler.

impl WlDisplay

pub const MSG__SYNC__SINCE: u32 = 1u32

Since when the sync message is available.

pub const MSG__GET_REGISTRY__SINCE: u32 = 1u32

Since when the get_registry message is available.

pub const MSG__ERROR__SINCE: u32 = 1u32

Since when the error message is available.

pub const MSG__DELETE_ID__SINCE: u32 = 1u32

Since when the delete_id message is available.

pub fn try_send_sync( &self, callback: &Rc<WlCallback>, ) -> Result<(), ObjectError>

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 undefined and should be ignored.

Arguments

• callback: callback object for the sync request

pub fn send_sync(&self, callback: &Rc<WlCallback>)

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 undefined and should be ignored.

Arguments

• callback: callback object for the sync request

pub fn new_try_send_sync(&self) -> Result<Rc<WlCallback>, ObjectError>

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 undefined and should be ignored.

pub fn new_send_sync(&self) -> Rc<WlCallback>

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 undefined and should be ignored.

pub fn try_send_get_registry( &self, registry: &Rc<WlRegistry>, ) -> Result<(), ObjectError>

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.

Arguments

• registry: global registry object

pub fn send_get_registry(&self, registry: &Rc<WlRegistry>)

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.

Arguments

• registry: global registry object

pub fn new_try_send_get_registry(&self) -> Result<Rc<WlRegistry>, ObjectError>

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.

pub fn new_send_get_registry(&self) -> Rc<WlRegistry>

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.

pub fn try_send_error( &self, object_id: Rc<dyn Object>, code: u32, message: &str, ) -> Result<(), ObjectError>

fatal error event

The error event is sent out when a fatal (non-recoverable) error has occurred. The object_id argument is the object where the error occurred, most often in response to a request to that object. The code identifies the error and is defined by the object interface. As such, each interface defines its own set of error codes. The message is a brief description of the error, for (debugging) convenience.

Arguments

• object_id: object where the error occurred
• code: error code
• message: error description

pub fn send_error(&self, object_id: Rc<dyn Object>, code: u32, message: &str)

fatal error event

The error event is sent out when a fatal (non-recoverable) error has occurred. The object_id argument is the object where the error occurred, most often in response to a request to that object. The code identifies the error and is defined by the object interface. As such, each interface defines its own set of error codes. The message is a brief description of the error, for (debugging) convenience.

Arguments

• object_id: object where the error occurred
• code: error code
• message: error description

pub fn try_send_delete_id(&self, id: u32) -> Result<(), ObjectError>

acknowledge object ID deletion

This event is used internally by the object ID management logic. When a client deletes an object that it had created, the server will send this event to acknowledge that it has seen the delete request. When the client receives this event, it will know that it can safely reuse the object ID.

Arguments

• id: deleted object ID

pub fn send_delete_id(&self, id: u32)

acknowledge object ID deletion

This event is used internally by the object ID management logic. When a client deletes an object that it had created, the server will send this event to acknowledge that it has seen the delete request. When the client receives this event, it will know that it can safely reuse the object ID.

Arguments

• id: deleted object ID

impl WlDisplay

pub const ENM__ERROR_INVALID_OBJECT__SINCE: u32 = 1u32

Since when the error.invalid_object enum variant is available.

pub const ENM__ERROR_INVALID_METHOD__SINCE: u32 = 1u32

Since when the error.invalid_method enum variant is available.

pub const ENM__ERROR_NO_MEMORY__SINCE: u32 = 1u32

Since when the error.no_memory enum variant is available.

pub const ENM__ERROR_IMPLEMENTATION__SINCE: u32 = 1u32

Since when the error.implementation enum variant is available.

Trait Implementations

impl ConcreteObject for WlDisplay

const XML_VERSION: u32 = 1u32

The interface version from the XML file that the interface was generated from.

const INTERFACE: ObjectInterface = ObjectInterface::WlDisplay

The interface of the object.

const INTERFACE_NAME: &str = "wl_display"

The interface of the object as a string.

impl Debug for WlDisplay

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

Formats the value using the given formatter.

impl Object for WlDisplay

fn core(&self) -> &ObjectCore

Returns the ObjectCore of this object.

fn unset_handler(&self)

Unsets the handler of this object.

fn get_handler_any_ref( &self, ) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError>

Returns a shared reference to the handler.

fn get_handler_any_mut( &self, ) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError>

Returns a mutable reference to the handler.