Struct wayland_commons::user_data::UserData

pub struct UserData { /* fields omitted */ }

A wrapper for user data, able to store any type, and correctly handling access from a wrong thread

Implementations

impl UserData

pub const fn new() -> UserData

Create a new UserData instance

pub fn set<T: Any + 'static, F: FnOnce() -> T>(&self, f: F)

Sets the UserData to a given value

The provided closure is called to init the UserData, does nothing is the UserData had already been set.

pub fn set_threadsafe<T: Any + Send + Sync + 'static, F: FnOnce() -> T>(
    &self,
    f: F
)

Sets the UserData to a given threadsafe value

The provided closure is called to init the UserData, does nothing is the UserData had already been set.

pub fn get<T: 'static>(&self) -> Option<&T>

Attempt to access the wrapped user data

Will return None if either:

• The requested type T does not match the type used for construction
• This UserData has been created using the non-threadsafe variant and access is attempted from an other thread than the one it was created on

Trait Implementations

impl Debug for UserData

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

Formats the value using the given formatter.

impl Drop for UserData

fn drop(&mut self)

Executes the destructor for this type.

impl Send for UserData

impl Sync for UserData