wayland_commons

Trait MessageGroup

Source 
pub trait MessageGroup: Sized {
    type Map;

    const MESSAGES: &'static [MessageDesc];

    // Required methods
    fn opcode(&self) -> u16;
    fn is_destructor(&self) -> bool;
    fn since(&self) -> u32;
    fn child<Meta: ObjectMetadata>(
        opcode: u16,
        version: u32,
        meta: &Meta,
    ) -> Option<Object<Meta>>;
    fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>;
    fn into_raw(self, send_id: u32) -> Message;
    unsafe fn from_raw_c(
        obj: *mut c_void,
        opcode: u32,
        args: *const wl_argument,
    ) -> Result<Self, ()>;
    fn as_raw_c_in<F, T>(self, f: F) -> T
       where F: FnOnce(u32, &mut [wl_argument]) -> T;
}
Expand description

A group of messages

This represents a group of message that can be serialized on the protocol wire. Typically the set of events or requests of a single interface.

Implementations of this trait are supposed to be generated using the wayland-scanner crate.

Required Associated Constants§

Source

const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

Required Associated Types§

Source

type Map

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

Required Methods§

Source

fn opcode(&self) -> u16

The opcode of this message

Source

fn is_destructor(&self) -> bool

Whether this message is a destructor

If it is, once send or receive the associated object cannot be used any more.

Source

fn since(&self) -> u32

The minimal object version for which this message exists

Source

fn child<Meta: ObjectMetadata>( opcode: u16, version: u32, meta: &Meta, ) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

Source

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

Source

fn into_raw(self, send_id: u32) -> Message

Turn this message into its raw representation

Source

unsafe fn from_raw_c( obj: *mut c_void, opcode: u32, args: *const wl_argument, ) -> Result<Self, ()>

Construct a message of this group from its C representation

§Safety

The pointers provided to this function must all be valid pointers from libwayland-client

Source

fn as_raw_c_in<F, T>(self, f: F) -> T
where F: FnOnce(u32, &mut [wl_argument]) -> T,

Build a C representation of this message

It can only be accessed from the provided closure, and this consumes the message.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§