Struct ManagedGc 

pub struct ManagedGc<T> { /* private fields */ }

Typed garbage collected box.

See the module docs for the ownership model.

Implementations

impl<T> ManagedGc<T>

pub fn new(data: T) -> Self

Allocates a value and owns it.

pub unsafe fn new_cyclic(f: impl FnOnce(Self) -> T) -> Self

Allocates a value that can point back at itself.

f is handed a reference to the box before the value exists, so it can store it inside the value it returns.

Safety

The handle passed to f points at memory that is not written yet. Storing it is fine, but reading or writing through it before f returns is undefined.

pub fn reference(&self) -> Self

Takes another handle that references the same value without owning it.

pub fn consume(self) -> Result<T, Self>

Takes the value out and frees the allocation.

Gives the box back when it does not own the value or something is accessing it.

pub fn into_dynamic(self) -> DynamicManagedGc

Erases the type.

pub fn renew(&mut self)

Replaces the lifetime, killing every reference taken so far. Does nothing on a referencing handle.

pub fn type_hash(&self) -> TypeHash

Returns the type of the value.

pub fn lifetime(&self) -> ManagedGcLifetime<'_>

Returns the borrow state, and with it whether this handle owns the value.

pub fn exists(&self) -> bool

Returns true while the value is alive.

Always true for the owner.

pub fn is_owning(&self) -> bool

Returns true when this handle owns the value.

pub fn is_referencing(&self) -> bool

Returns true when this handle only references the value.

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

Returns true when this handle references the value that other owns.

pub fn transfer_ownership(&mut self, new_owner: &mut Self) -> bool

Hands ownership over to a handle that references this value.

Returns false unless this handle owns the value and new_owner references it.

pub fn try_read(&self) -> Option<ValueReadAccess<'_, T>>

Guards the value for reading, or returns None when it is busy or gone.

pub fn try_write(&mut self) -> Option<ValueWriteAccess<'_, T>>

Guards the value for writing, or returns None when it is busy or gone.

pub fn read<const LOCKING: bool>(&self) -> ValueReadAccess<'_, T>

Guards the value for reading, spinning until it is free when LOCKING.

Panics

Panics when the value is gone, or when it is busy and LOCKING is false.

pub fn write<const LOCKING: bool>(&mut self) -> ValueWriteAccess<'_, T>

Guards the value for writing, spinning until it is free when LOCKING.

Panics

Panics when the value is gone, or when it is busy and LOCKING is false.

pub fn try_borrow(&self) -> Option<ManagedRef<T>>

Takes a shared handle, or returns None when the value is busy or gone.

pub fn try_borrow_mut(&self) -> Option<ManagedRefMut<T>>

Takes an exclusive handle, or returns None when the value is busy or gone.

pub fn borrow<const LOCKING: bool>(&self) -> ManagedRef<T>

Takes a shared handle, spinning until it is free when LOCKING.

Panics

Panics when the value is gone, or when it is busy and LOCKING is false.

pub fn borrow_mut<const LOCKING: bool>(&mut self) -> ManagedRefMut<T>

Takes an exclusive handle, spinning until it is free when LOCKING.

Panics

Panics when the value is gone, or when it is busy and LOCKING is false.

pub fn lazy(&self) -> ManagedLazy<T>

Takes an unclaimed handle, which claims nothing and never blocks.

Panics

Panics when the value is gone.

pub unsafe fn as_ptr(&self) -> *const T

Returns a pointer to the value, checking nothing.

Safety

Neither the borrow state nor whether the value is still alive is checked.

pub unsafe fn as_mut_ptr(&mut self) -> *mut T

Returns a mutable pointer to the value, checking nothing.

Safety

Neither the borrow state nor whether the value is still alive is checked.

Trait Implementations

impl<T: Default> Default for ManagedGc<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<ManagedGc<T>> for ManagedValue<T>

fn from(value: ManagedGc<T>) -> Self

Converts to this type from the input type.

impl<T> Send for ManagedGc<T>

impl<T> Sync for ManagedGc<T>

impl<T> TryFrom<ManagedValue<T>> for ManagedGc<T>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: ManagedValue<T>) -> Result<Self, Self::Error>

Performs the conversion.