Struct DynamicManagedRef 

pub struct DynamicManagedRef { /* private fields */ }

Shared handle to a value whose type is only known at runtime.

The ManagedRef counterpart for script values.

Implementations

impl DynamicManagedRef

pub fn new<T>(data: &T, lifetime: LifetimeRef) -> DynamicManagedRef

where T: ?Sized,

Pairs a reference with a shared borrow taken from its lifetime.

pub unsafe fn new_raw( type_hash: TypeHash, lifetime: LifetimeRef, data: *const u8, ) -> Option<DynamicManagedRef>

DynamicManagedRef::new for a type only known at runtime. A null pointer yields None.

Safety

data must point at a value of the type named by type_hash, and must stay valid for as long as lifetime says it does.

pub fn make<T>(data: &T) -> (DynamicManagedRef, Lifetime)

where T: ?Sized,

Builds a handle to a plain reference along with the lifetime that backs it.

pub fn into_inner(self) -> (TypeHash, LifetimeRef, *const u8)

Splits into type, borrow token and pointer.

pub fn into_typed<T>(self) -> Result<ManagedRef<T>, DynamicManagedRef>

Recovers the typed handle, or gives self back on a type mismatch.

pub fn type_hash(&self) -> &TypeHash

Returns the type of the value.

pub fn lifetime(&self) -> &LifetimeRef

Returns the borrow token.

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

Takes another shared handle to the same value.

pub unsafe fn lazy_immutable(&self) -> DynamicManagedLazy

Turns this shared handle into an unclaimed one that can also write.

Safety

The value was only borrowed immutably, so writing through the result is only sound when nothing else holds a shared reference to it.

pub fn is<T>(&self) -> bool

Returns true when the value is a T.

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

Guards the value for reading, or returns None on a type mismatch or while it is written.

pub unsafe fn map<T, U>( self, f: impl FnOnce(&T) -> &U, ) -> Option<DynamicManagedRef>

Narrows this handle down to a part of the value, retyping it to U.

Safety

f must return a reference into the same value, and the owner must still be alive. Returns None when the value is not a T.

pub unsafe fn try_map<T, U>( self, f: impl FnOnce(&T) -> Option<&U>, ) -> Option<DynamicManagedRef>

DynamicManagedRef::map that can decline.

Safety

Same as DynamicManagedRef::map.

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

Returns a typed pointer while the owner is alive.

Safety

The caller takes over checking for conflicting access.

pub unsafe fn as_ptr_raw(&self) -> Option<*const u8>

Returns the untyped pointer while the owner is alive.

Safety

Neither the type nor conflicting access is checked.

Trait Implementations

impl From<DynamicManagedRef> for DynamicManagedValue

fn from(value: DynamicManagedRef) -> DynamicManagedValue

Converts to this type from the input type.

impl Send for DynamicManagedRef

impl Sync for DynamicManagedRef

impl TryFrom<DynamicManagedValue> for DynamicManagedRef

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: DynamicManagedValue, ) -> Result<DynamicManagedRef, <DynamicManagedRef as TryFrom<DynamicManagedValue>>::Error>

Performs the conversion.

impl ValueDependency<DynamicManagedRef> for ManagedValueDependency

fn as_ref(value: &DynamicManagedRef) -> ManagedValueDependency

Takes a shared borrow from value.

fn as_ref_mut(_: &mut DynamicManagedRef) -> ManagedValueDependency

Takes an exclusive borrow from value.