Struct netsblox_vm::gc::GcWeak

pub struct GcWeak<'gc, T>
where
    T: 'gc + ?Sized,
{ /* private fields */ }

Implementations

impl<'gc, T> GcWeak<'gc, T>

where T: 'gc + ?Sized,

pub fn upgrade(self, mc: &Mutation<'gc>) -> Option<Gc<'gc, T>>

pub fn is_dropped(self) -> bool

Returns whether the value referenced by this GcWeak has been dropped.

Note that calling upgrade may still fail even when this method returns false.

pub fn ptr_eq(this: GcWeak<'gc, T>, other: GcWeak<'gc, T>) -> bool

pub fn as_ptr(self) -> *const T

impl<'gc, T> GcWeak<'gc, T>

where T: 'gc,

pub unsafe fn cast<U>(this: GcWeak<'gc, T>) -> GcWeak<'gc, U>

where U: 'gc,

Cast the internal pointer to a different type.

SAFETY: It must be valid to dereference a *mut U that has come from casting a *mut T.

pub unsafe fn from_ptr(ptr: *const T) -> GcWeak<'gc, T>

Retrieve a GcWeak from a raw pointer obtained from GcWeak::as_ptr

SAFETY: The provided pointer must have been obtained from GcWeak::as_ptr or Gc::as_ptr, and the pointer must not have been fully collected yet (it may be a dropped but live weak pointer).

Trait Implementations

impl<'gc, T> Clone for GcWeak<'gc, T>

where T: 'gc + ?Sized,

fn clone(&self) -> GcWeak<'gc, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'gc, T> Collect for GcWeak<'gc, T>

where T: 'gc + ?Sized,

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

fn needs_trace() -> bool

where Self: Sized,

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

impl<'gc, T> Debug for GcWeak<'gc, T>

where T: 'gc + ?Sized,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'gc, T> Copy for GcWeak<'gc, T>

where T: 'gc + ?Sized,