Struct gdnative_core::export::user_data::MutexData

pub struct MutexData<T, OPT = DefaultLockPolicy> { /* private fields */ }

User-data wrapper encapsulating a Arc<Mutex<T>>.

The underlying Mutex may change in the future. The current implementation is parking_lot.

Trait Implementations

impl<T, OPT> Clone for MutexData<T, OPT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, OPT: Debug> Debug for MutexData<T, OPT>

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

Formats the value using the given formatter.

impl<T, OPT> Map for MutexData<T, OPT> where
    T: NativeClass + Send,
    OPT: LockOptions, 

type Err = LockFailed

fn map<F, U>(&self, op: F) -> Result<U, LockFailed> where
    F: FnOnce(&T) -> U, 

Maps a &T to U. Called for methods that take &self.

impl<T, OPT> MapMut for MutexData<T, OPT> where
    T: NativeClass + Send,
    OPT: LockOptions, 

type Err = LockFailed

fn map_mut<F, U>(&self, op: F) -> Result<U, LockFailed> where
    F: FnOnce(&mut T) -> U, 

Maps a &mut T to U. Called for methods that take &mut self.

impl<T, OPT> UserData for MutexData<T, OPT> where
    T: NativeClass + Send,
    OPT: LockOptions, 

type Target = T

fn new(val: Self::Target) -> Self

Creates a new owned wrapper from a NativeClass instance.

fn into_user_data(self) -> *const c_void

Takes a native instance and returns an opaque pointer that can be used to recover it.

unsafe fn consume_user_data_unchecked(ptr: *const c_void) -> Self

Takes an opaque pointer produced by into_user_data and “consumes” it to produce the original instance, keeping the reference count.

unsafe fn clone_from_user_data_unchecked(ptr: *const c_void) -> Self

Takes an opaque pointer produced by into_user_data and “clones” it to produce the original instance, increasing the reference count.