Struct gstd::sync::MutexLockFuture

pub struct MutexLockFuture<'a, T> { /* private fields */ }

The future returned by the lock method.

The output of the future is the MutexGuard that can be obtained by using await syntax.

Examples

In the following example, variable types are annotated explicitly for demonstration purposes only. Usually, annotating them is unnecessary because they can be inferred automatically.

use gstd::sync::{Mutex, MutexGuard, MutexLockFuture};

#[gstd::async_main]
async fn main() {
    let mutex: Mutex<i32> = Mutex::new(42);
    let future: MutexLockFuture<i32> = mutex.lock();
    let guard: MutexGuard<i32> = future.await;
    let value: i32 = *guard;
    assert_eq!(value, 42);
}

Implementations

impl<'a, T> MutexLockFuture<'a, T>

pub fn own_up_for(self, block_count: BlockCount) -> Result<Self>

Sets the maximum number of blocks the mutex lock can be owned by some message before the ownership can be seized by another rival

Trait Implementations

impl<'a, T> Future for MutexLockFuture<'a, T>

type Output = MutexGuard<'a, T>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.