Struct LifetimeLazy 

pub struct LifetimeLazy(/* private fields */);

Handle that claims nothing until it is used.

Unlike LifetimeRef and LifetimeRefMut, holding one blocks nobody, and it can be cloned freely. Each call checks the conditions again, so it is the right handle for a value that is looked up now and touched later, such as a script variable.

Implementations

impl LifetimeLazy

pub fn state(&self) -> &LifetimeWeakState

Returns the weak state this handle points at.

pub fn tag(&self) -> usize

Returns the tag the owner had when this handle was taken.

pub fn exists(&self) -> bool

Returns true while the owning Lifetime is alive and valid.

pub fn is_read_accessible(&self) -> bool

Returns true when no write guard is live.

pub fn is_write_accessible(&self) -> bool

Returns true when no access guard of any kind is live.

pub fn is_in_use(&self) -> bool

Returns true while any access guard is live.

pub fn is_owned_by(&self, other: &Lifetime) -> bool

Returns true when this handle came from other.

pub fn borrow(&self) -> Option<LifetimeRef>

Upgrades to a real shared borrow.

pub async fn borrow_async(&self) -> LifetimeRef

LifetimeLazy::borrow, awaiting until it succeeds.

pub fn borrow_mut(&self) -> Option<LifetimeRefMut>

Upgrades to a real top level mutable borrow, which needs no other borrow to be out.

pub async fn borrow_mut_async(&self) -> LifetimeRefMut

LifetimeLazy::borrow_mut, awaiting until it succeeds.

pub fn read<'a, T>(&'a self, data: &'a T) -> Option<ValueReadAccess<'a, T>>

where T: ?Sized,

Guards data for reading, or returns None while a write guard is live or the owner is gone.

pub async fn read_async<'a, T>(&'a self, data: &'a T) -> ValueReadAccess<'a, T>

where T: ?Sized,

LifetimeLazy::read, awaiting until it succeeds.

pub unsafe fn read_ptr<T>( &self, data: *const T, ) -> Option<ValueReadAccess<'_, T>>

where T: ?Sized,

LifetimeLazy::read over a raw pointer.

Safety

data must stay valid and aligned for as long as the returned guard lives. A null pointer yields None.

pub async unsafe fn read_ptr_async<'a, T>( &'a self, data: *const T, ) -> ValueReadAccess<'a, T>

where T: 'a + ?Sized,

LifetimeLazy::read_ptr, awaiting until it succeeds.

Safety

Same as LifetimeLazy::read_ptr, and data must also stay valid across every await point.

pub fn write<'a, T>( &'a self, data: &'a mut T, ) -> Option<ValueWriteAccess<'a, T>>

where T: ?Sized,

Guards data for writing, or returns None while any other access guard is live or the owner is gone.

pub async fn write_async<'a, T>( &'a self, data: &'a mut T, ) -> ValueWriteAccess<'a, T>

where T: ?Sized,

LifetimeLazy::write, awaiting until it succeeds.

pub unsafe fn write_ptr<T>( &self, data: *mut T, ) -> Option<ValueWriteAccess<'_, T>>

where T: ?Sized,

LifetimeLazy::write over a raw pointer.

Safety

data must stay valid, aligned and unaliased for as long as the returned guard lives. A null pointer yields None.

pub async unsafe fn write_ptr_async<'a, T>( &'a self, data: *mut T, ) -> ValueWriteAccess<'a, T>

where T: 'a + ?Sized,

LifetimeLazy::write_ptr, awaiting until it succeeds.

Safety

Same as LifetimeLazy::write_ptr, and data must also stay valid across every await point.

pub fn consume<T>( self, data: &mut T, ) -> Result<ValueWriteAccess<'_, T>, LifetimeLazy>

where T: ?Sized,

Turns this handle into a write guard over data.

Gives the handle back unchanged when another access guard is live.

pub async fn wait_for_read_access(&self)

Awaits until reading would be allowed, or the owner is gone.

pub async fn wait_for_write_access(&self)

Awaits until writing would be allowed, or the owner is gone.

Trait Implementations

impl Clone for LifetimeLazy

fn clone(&self) -> LifetimeLazy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.