Struct components_arena::ComponentClassMutex [−][src]
pub struct ComponentClassMutex<C: ComponentClass>(_);
Expand description
Helps to store ComponentClassToken
in a static.
Examples
macro_attr! { #[derive(Component!)] struct MyComponent { /* ... */ } } static MY_COMPONENT: ComponentClassMutex<MyComponent> = ComponentClassMutex::new(); // ... let mut arena = Arena::new(&mut MY_COMPONENT.lock().unwrap());
Implementations
Methods from Deref<Target = Mutex<ComponentClassToken<C>>>
Acquires a mutex, blocking the current thread until it is able to do so.
This function will block the local thread until it is available to acquire the mutex. Upon returning, the thread is the only thread with the lock held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.
The exact behavior on locking a mutex in the thread which already holds the lock is left unspecified. However, this function will not return on the second call (it might panic or deadlock, for example).
Errors
If another user of this mutex panicked while holding the mutex, then this call will return an error once the mutex is acquired.
Panics
This function might panic when called if the lock is already held by the current thread.
Examples
use std::sync::{Arc, Mutex}; use std::thread; let mutex = Arc::new(Mutex::new(0)); let c_mutex = Arc::clone(&mutex); thread::spawn(move || { *c_mutex.lock().unwrap() = 10; }).join().expect("thread::spawn failed"); assert_eq!(*mutex.lock().unwrap(), 10);
Attempts to acquire this lock.
If the lock could not be acquired at this time, then Err
is returned.
Otherwise, an RAII guard is returned. The lock will be unlocked when the
guard is dropped.
This function does not block.
Errors
If another user of this mutex panicked while holding the mutex, then
this call will return the Poisoned
error if the mutex would
otherwise be acquired.
If the mutex could not be acquired because it is already locked, then
this call will return the WouldBlock
error.
Examples
use std::sync::{Arc, Mutex}; use std::thread; let mutex = Arc::new(Mutex::new(0)); let c_mutex = Arc::clone(&mutex); thread::spawn(move || { let mut lock = c_mutex.try_lock(); if let Ok(ref mut mutex) = lock { **mutex = 10; } else { println!("try_lock failed"); } }).join().expect("thread::spawn failed"); assert_eq!(*mutex.lock().unwrap(), 10);
Determines whether the mutex is poisoned.
If another thread is active, the mutex can still become poisoned at any
time. You should not trust a false
value for program correctness
without additional synchronization.
Examples
use std::sync::{Arc, Mutex}; use std::thread; let mutex = Arc::new(Mutex::new(0)); let c_mutex = Arc::clone(&mutex); let _ = thread::spawn(move || { let _lock = c_mutex.lock().unwrap(); panic!(); // the mutex gets poisoned }).join(); assert_eq!(mutex.is_poisoned(), true);
Trait Implementations
Auto Trait Implementations
impl<C> RefUnwindSafe for ComponentClassMutex<C>
impl<C> Send for ComponentClassMutex<C>
impl<C> Sync for ComponentClassMutex<C>
impl<C> Unpin for ComponentClassMutex<C>
impl<C> UnwindSafe for ComponentClassMutex<C>