Struct wayland_commons::filter::Filter

pub struct Filter<E> { /* private fields */ }

An event filter

Can be used in wayland-client and wayland-server to aggregate messages from different objects into the same closure.

You need to provide it a closure of type FnMut(E, &Filter<E>), which will be called any time a message is sent to the filter via the send(..) method. Your closure also receives a handle to the filter as argument, so that you can use it from within the callback (to assign new wayland objects to this filter for example).

The Filter can be cloned, and all clones send messages to the same closure. However it is not threadsafe.

Implementations

impl<E> Filter<E>

pub fn new<F: FnMut(E, &Filter<E>, DispatchData<'_>) + 'static>( f: F ) -> Filter<E>

Create a new filter from given closure

pub fn send(&self, evt: E, data: DispatchData<'_>)

Send a message to this filter

Trait Implementations

impl<E> Clone for Filter<E>

fn clone(&self) -> Filter<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Filter<E>

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

Formats the value using the given formatter.