Struct futures_util::lock::BiLockGuard

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

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<'a, T> BiLockGuard<'a, T>

pub fn as_pin_mut(&mut self) -> PinMut<T>

Get a mutable pinned reference to the locked value.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a, T> Deref for BiLockGuard<'a, T>

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: Unpin> DerefMut for BiLockGuard<'a, T>

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T> Drop for BiLockGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.