Struct wayland_commons::filter::DispatchData

pub struct DispatchData<'a> { /* fields omitted */ }

Holder of global dispatch-related data

This struct serves as a dynamic container for the dispatch-time global data that you gave to the dispatch method, and is given as input to all your callbacks. It allows you to share global state between your filters.

The main method of interest is the get method, which allows you to access a &mut _ reference to the global data itself. The other methods are mostly used internally by the crate.

Implementations

impl<'a> DispatchData<'a>

pub fn get<T: Any>(&mut self) -> Option<&mut T>

Access the dispatch data knowing its type

Will return None if the provided type is not the correct inner type.

pub fn wrap<T: Any>(data: &'a mut T) -> DispatchData<'a>

Wrap a mutable reference

This creates a new DispatchData from a mutable reference

pub fn reborrow(&mut self) -> DispatchData<'_>

Reborrows this DispatchData to create a new one with the same content

This is a quick and cheap way to propagate the DispatchData down a callback stack by value. It is basically a noop only there to ease work with the borrow checker.

Trait Implementations

impl<'a> Debug for DispatchData<'a>

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

Formats the value using the given formatter.