Struct wayland_server::Main

pub struct Main<I: Interface + AsRef<Resource<I>> + From<Resource<I>>> { /* private fields */ }

A main handle to a proxy

Implementations

impl<I: Interface> Main<I> where
    I: AsRef<Resource<I>> + From<Resource<I>>, 

pub fn assign<E>(&self, filter: Filter<E>) where
    I: AsRef<Resource<I>> + From<Resource<I>>,
    E: From<(Main<I>, I::Request)> + 'static,
    I::Request: MessageGroup<Map = ResourceMap>, 

Assign this object to given filter

All future requests received by this object will be delivered to this filter.

An object that is not assigned to any filter will see trigger a protocol error and kill its client signalling a server bug if it receives a request.

Message type of the filter should verify E: From<(Main<I>, I::Request)>. See the request_enum! macro provided in this library to easily generate appropriate types.

pub fn quick_assign<F>(&self, f: F) where
    I: Interface + AsRef<Resource<I>> + From<Resource<I>>,
    F: FnMut(Main<I>, I::Request, DispatchData<'_>) + 'static,
    I::Request: MessageGroup<Map = ResourceMap>, 

Shorthand for assigning a closure to an object

Behaves similarly as assign(..), but is a shorthand if you want to assign this object to its own filter. In which case you just need to provide the appropriate closure, of type FnMut(Main<I>, I::Event).

pub fn assign_destructor<E>(&self, filter: Filter<E>) where
    I: AsRef<Resource<I>> + From<Resource<I>>,
    E: From<Resource<I>> + 'static, 

Assign a destructor to this object

The filter will be called upon destruction of this object with a payload of type Resource<I>.

pub unsafe fn init_from_c_ptr(_ptr: *mut wl_resource) -> Self

Create a Main instance from a C pointer to a new object

Create a Main from a raw pointer to a wayland object from the C library by taking control of it.

In order to handle protocol races, invoking it with a NULL pointer will create an already-dead object.

NOTE: This method will panic if called while the use_system_lib feature is not activated

Safety

The provided pointer must be a valid pointer to a wayland object from libwayland-client associated to the correct interface.

You must ensure that this object was newly created and have never been user nor had any listener associated.

Trait Implementations

impl<I: Clone + Interface + AsRef<Resource<I>> + From<Resource<I>>> Clone for Main<I>

fn clone(&self) -> Main<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Interface> Debug for Main<I> where
    I: Debug + AsRef<Resource<I>> + From<Resource<I>>, 

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

Formats the value using the given formatter.

impl<I> Deref for Main<I> where
    I: Interface + AsRef<Resource<I>> + From<Resource<I>>, 

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &I

Dereferences the value.

impl<I: PartialEq + Interface + AsRef<Resource<I>> + From<Resource<I>>> PartialEq<Main<I>> for Main<I>

fn eq(&self, other: &Main<I>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: Interface + AsRef<Resource<I>> + From<Resource<I>>> StructuralPartialEq for Main<I>