Структура Mutex

Создаёт новую блокировку в незаблокированном состоянии, готовую к использованию.

Примеры

use tokio::sync::Mutex;

let lock = Mutex::new(5);

Создаёт новую блокировку в незаблокированном состоянии, готовую к использованию.

При использовании нестабильной функции tracing объект Mutex, созданный с помощью const_new, не будет инструментирован. Поэтому он не будет виден в tokio-console. Вместо этого, если требуется создать инструментированный объект, следует использовать Mutex::new.

Примеры

use tokio::sync::Mutex;

static LOCK: Mutex<i32> = Mutex::const_new(5);

Блокирует этот мьютекс, заставляя текущую задачу уступить управление до получения блокировки. После получения блокировки функция возвращает MutexGuard.

Если мьютекс доступен для немедленного получения, этот вызов обычно не передаёт управление среде выполнения. Однако это не гарантируется при любых обстоятельствах.

Безопасность отмены

Этот метод использует очередь для справедливого распределения блокировок в порядке их запроса. Отмена вызова lock приведёт к потере места в очереди.

Примеры

use tokio::sync::Mutex;

let mutex = Mutex::new(1);

let mut n = mutex.lock().await;
*n = 2;

Блокирующим образом блокирует этот Mutex. После получения блокировки функция возвращает MutexGuard.

Этот метод предназначен для случаев, когда мьютекс необходимо использовать как в асинхронном, так и в синхронном коде.

Паника

Эта функция вызывает панику, если её вызвать в контексте асинхронного выполнения.

• Если вы находитесь в контексте асинхронного выполнения и вам нужно вызвать синхронную функцию, выполняющую одну из этих операций blocking_, рассмотрите возможность обернуть этот вызов в spawn_blocking() (или block_in_place()).

Примеры

use std::sync::Arc;
use tokio::sync::Mutex;

#[tokio::main]
async fn main() {
    let mutex =  Arc::new(Mutex::new(1));
    let lock = mutex.lock().await;

    let mutex1 = Arc::clone(&mutex);
    let blocking_task = tokio::task::spawn_blocking(move || {
        // This shall block until the `lock` is released.
        let mut n = mutex1.blocking_lock();
        *n = 2;
    });

    assert_eq!(*lock, 1);
    // Release the lock.
    drop(lock);

    // Await the completion of the blocking task.
    blocking_task.await.unwrap();

    // Assert uncontended.
    let n = mutex.try_lock().unwrap();
    assert_eq!(*n, 2);
}

Блокирующим образом блокирует этот Mutex. После получения блокировки функция возвращает OwnedMutexGuard.

Этот метод идентичен Mutex::blocking_lock, за исключением того, что возвращаемый объект блокировки ссылается на Mutex через Arc, а не заимствует его. Поэтому для вызова этого метода Mutex должен быть обёрнут в Arc, а объект блокировки будет существовать в течение времени жизни 'static, поскольку он удерживает Mutex в памяти, хранящий Arc.

Паника

Эта функция вызывает панику, если её вызвать в контексте асинхронного выполнения.

• Если вы находитесь в контексте асинхронного выполнения и вам нужно вызвать синхронную функцию, выполняющую одну из этих операций blocking_, рассмотрите возможность обернуть этот вызов в spawn_blocking() (или block_in_place()).

Примеры

use std::sync::Arc;
use tokio::sync::Mutex;

#[tokio::main]
async fn main() {
    let mutex =  Arc::new(Mutex::new(1));
    let lock = mutex.lock().await;

    let mutex1 = Arc::clone(&mutex);
    let blocking_task = tokio::task::spawn_blocking(move || {
        // This shall block until the `lock` is released.
        let mut n = mutex1.blocking_lock_owned();
        *n = 2;
    });

    assert_eq!(*lock, 1);
    // Release the lock.
    drop(lock);

    // Await the completion of the blocking task.
    blocking_task.await.unwrap();

    // Assert uncontended.
    let n = mutex.try_lock().unwrap();
    assert_eq!(*n, 2);
}

Блокирует этот мьютекс, приостанавливая текущую задачу до получения блокировки. После получения блокировки этот метод возвращает OwnedMutexGuard.

Если мьютекс можно заблокировать немедленно, этот вызов обычно не передаёт управление среде выполнения. Однако это не гарантируется во всех случаях.

Этот метод идентичен Mutex::lock, за исключением того, что возвращаемый объект-охранитель ссылается на Mutex с помощью Arc, а не заимствует его. Поэтому для вызова этого метода Mutex необходимо обернуть в Arc, а объект-охранитель будет жить в течение времени жизни 'static, поскольку он удерживает Mutex живым, храня Arc.

Безопасность отмены

Этот метод использует очередь, чтобы справедливо распределять блокировки в порядке поступления запросов. Отмена вызова lock_owned приводит к потере места в очереди.

Примеры

use tokio::sync::Mutex;
use std::sync::Arc;

let mutex = Arc::new(Mutex::new(1));

let mut n = mutex.clone().lock_owned().await;
*n = 2;

Пытается получить блокировку и возвращает TryLockError, если мьютекс в данный момент заблокирован где-либо ещё.

Примеры

use tokio::sync::Mutex;

let mutex = Mutex::new(1);

let n = mutex.try_lock()?;
assert_eq!(*n, 1);

Возвращает изменяемую ссылку на базовые данные.

Поскольку этот вызов изменяемо заимствует Mutex, фактическая блокировка не требуется: изменяемое заимствование на этапе компиляции гарантирует отсутствие блокировок.

Примеры

use tokio::sync::Mutex;

fn main() {
    let mut mutex = Mutex::new(1);

    let n = mutex.get_mut();
    *n = 2;
}

Пытается получить блокировку и возвращает TryLockError, если мьютекс в данный момент заблокирован где-либо ещё.

Этот метод идентичен Mutex::try_lock, за исключением того, что возвращаемый объект-охранитель ссылается на Mutex с помощью Arc, а не заимствует его. Поэтому для вызова этого метода Mutex необходимо обернуть в Arc, а объект-охранитель будет жить в течение времени жизни 'static, поскольку он удерживает Mutex живым, храня Arc.

Примеры

use tokio::sync::Mutex;
use std::sync::Arc;

let mutex = Arc::new(Mutex::new(1));

let n = mutex.clone().try_lock_owned()?;
assert_eq!(*n, 1);

Потребляет мьютекс и возвращает базовые данные.

Примеры

use tokio::sync::Mutex;

let mutex = Mutex::new(1);

let n = mutex.into_inner();
assert_eq!(n, 1);

Возвращает аргумент без изменений.

Вызывает U::from(self).

То есть это преобразование выполняет то, что выбирает реализация From<T> for U.