Struct gstd::sync::RwLockReadFuture

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

The future returned by the read method.

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

Examples

The following example explicitly annotates variable types for demonstration purposes only. Usually, annotating types is unnecessary since they can be inferred automatically.

use gstd::sync::{RwLock, RwLockReadFuture, RwLockReadGuard};

#[gstd::async_main]
async fn main() {
    let rwlock: RwLock<i32> = RwLock::new(42);
    let future: RwLockReadFuture<i32> = rwlock.read();
    let guard: RwLockReadGuard<i32> = future.await;
    let value: i32 = *guard;
    assert_eq!(value, 42);
}

Trait Implementations

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

type Output = RwLockReadGuard<'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.