Struct futures_util::lock::BiLockGuard

[+] Show declaration

pub struct BiLockGuard<'a, T> { /* fields omitted */ }

[−] Expand description

Returned RAII guard from the poll_lock method.

This structure acts as a sentinel to the data in the BiLock<T> itself, implementing Deref and DerefMut to T. When dropped, the lock will be unlocked.

Methods

impl<T, '_> BiLockGuard<'_, T>[−]

Important traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future,  type Output = <<P as Deref>::Target as Future>::Output;

pub fn as_pin_mut(&mut self) -> Pin<&mut T>[+]

Get a mutable pinned reference to the locked value.

Trait Implementations

impl<T, '_> Drop for BiLockGuard<'_, T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[+]

Executes the destructor for this type.

impl<T: Unpin, '_> DerefMut for BiLockGuard<'_, T>[+]

[+] Show hidden undocumented items

Important traits for &'_ mut I

impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

fn deref_mut(&mut self) -> &mut T[+]

Mutably dereferences the value.

impl<T, '_> Deref for BiLockGuard<'_, T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

Important traits for &'_ mut I

impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

fn deref(&self) -> &T[+]

Dereferences the value.

impl<'a, T: Debug> Debug for BiLockGuard<'a, T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[+]

Formats the value using the given formatter.