type CrossDomainJobs = Mutex<Option<VecDeque<CrossDomainJob>>>;

Aliased Type§

struct CrossDomainJobs {
    inner: Mutex,
    poison: Flag,
    data: UnsafeCell<Option<VecDeque<CrossDomainJob>>>,
}

Fields§

§inner: Mutex§poison: Flag§data: UnsafeCell<Option<VecDeque<CrossDomainJob>>>

Implementations

source§

impl<T> Mutex<T>

1.0.0 (const: 1.63.0) · source

pub const fn new(t: T) -> Mutex<T>

Creates a new mutex in an unlocked state ready for use.

§Examples
use std::sync::Mutex;

let mutex = Mutex::new(0);
source§

impl<T> Mutex<T>
where T: ?Sized,

1.0.0 · source

pub fn lock(&self) -> Result<MutexGuard<'_, T>, PoisonError<MutexGuard<'_, T>>>

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);
1.0.0 · source

pub fn try_lock( &self ) -> Result<MutexGuard<'_, T>, TryLockError<MutexGuard<'_, T>>>

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);
source

pub fn unlock(guard: MutexGuard<'_, T>)

🔬This is a nightly-only experimental API. (mutex_unlock)

Immediately drops the guard, and consequently unlocks the mutex.

This function is equivalent to calling drop on the guard but is more self-documenting. Alternately, the guard will be automatically dropped when it goes out of scope.

#![feature(mutex_unlock)]

use std::sync::Mutex;
let mutex = Mutex::new(0);

let mut guard = mutex.lock().unwrap();
*guard += 20;
Mutex::unlock(guard);
1.2.0 · source

pub fn is_poisoned(&self) -> bool

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);
1.77.0 · source

pub fn clear_poison(&self)

Clear the poisoned state from a mutex

If the mutex is poisoned, it will remain poisoned until this function is called. This allows recovering from a poisoned state and marking that it has recovered. For example, if the value is overwritten by a known-good value, then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to determine if it is in a consistent state, and if so the poison is removed.

§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);
let x = mutex.lock().unwrap_or_else(|mut e| {
    **e.get_mut() = 1;
    mutex.clear_poison();
    e.into_inner()
});
assert_eq!(mutex.is_poisoned(), false);
assert_eq!(*x, 1);
1.6.0 · source

pub fn into_inner(self) -> Result<T, PoisonError<T>>

Consumes this mutex, returning the underlying data.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error instead.

§Examples
use std::sync::Mutex;

let mutex = Mutex::new(0);
assert_eq!(mutex.into_inner().unwrap(), 0);
1.6.0 · source

pub fn get_mut(&mut self) -> Result<&mut T, PoisonError<&mut T>>

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist.

§Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error instead.

§Examples
use std::sync::Mutex;

let mut mutex = Mutex::new(0);
*mutex.get_mut().unwrap() = 10;
assert_eq!(*mutex.lock().unwrap(), 10);

Trait Implementations

1.12.0 · source§

impl<T> RefUnwindSafe for Mutex<T>
where T: ?Sized,

1.0.0 · source§

impl<T> Sync for Mutex<T>
where T: Send + ?Sized,

1.0.0 · source§

impl<T> Debug for Mutex<T>
where T: Debug + ?Sized,

source§

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

Formats the value using the given formatter. Read more
1.24.0 · source§

impl<T> From<T> for Mutex<T>

source§

fn from(t: T) -> Mutex<T>

Creates a new mutex in an unlocked state ready for use. This is equivalent to Mutex::new.

1.10.0 · source§

impl<T> Default for Mutex<T>
where T: Default + ?Sized,

source§

fn default() -> Mutex<T>

Creates a Mutex<T>, with the Default value for T.

1.0.0 · source§

impl<T> Send for Mutex<T>
where T: Send + ?Sized,

1.9.0 · source§

impl<T> UnwindSafe for Mutex<T>
where T: ?Sized,

source§

impl<'de, T> Deserialize<'de> for Mutex<T>
where T: Deserialize<'de>,

source§

fn deserialize<D>( deserializer: D ) -> Result<Mutex<T>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> Serialize for Mutex<T>
where T: Serialize,

source§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more