Struct boa_gc::Gc

pub struct Gc<T: Trace + ?Sized + 'static> { /* private fields */ }

A garbage-collected pointer type over an immutable value.

Implementations

impl<T: Trace + ?Sized> Gc<T>

pub fn new(value: T) -> Self

where T: Sized,

Constructs a new Gc<T> with the given value.

pub fn new_cyclic<F>(data_fn: F) -> Self

where F: FnOnce(&WeakGc<T>) -> T, T: Sized,

Constructs a new Gc<T> while giving you a WeakGc<T> to the allocation, to allow constructing a T which holds a weak pointer to itself.

Since the new Gc<T> is not fully-constructed until Gc<T>::new_cyclic returns, calling upgrade on the weak reference inside the closure will fail and result in a None value.

pub fn into_raw(this: Self) -> NonNull<GcBox<T>>

Consumes the Gc, returning a wrapped raw pointer.

To avoid a memory leak, the pointer must be converted back to a Gc using Gc::from_raw.

pub fn ptr_eq(this: &Self, other: &Self) -> bool

Returns true if the two Gcs point to the same allocation.

pub const unsafe fn from_raw(inner_ptr: NonNull<GcBox<T>>) -> Self

Constructs a Gc<T> from a raw pointer.

The raw pointer must have been returned by a previous call to Gc<U>::into_raw where U must have the same size and alignment as T.

Safety

This function is unsafe because improper use may lead to memory corruption, double-free, or misbehaviour of the garbage collector.

Trait Implementations

impl<T: Trace + ?Sized> AsRef<T> for Gc<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Trace + ?Sized> Borrow<T> for Gc<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Trace + ?Sized> Clone for Gc<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Trace + ?Sized + Debug> Debug for Gc<T>

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

Formats the value using the given formatter.

impl<T: Trace + Default> Default for Gc<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Trace + ?Sized> Deref for Gc<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Trace + ?Sized + Display> Display for Gc<T>

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

Formats the value using the given formatter.

impl<T: Trace + ?Sized> Drop for Gc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Trace + ?Sized> Finalize for Gc<T>

fn finalize(&self)

Cleanup logic for a type.

impl<T: Trace + ?Sized + Hash> Hash for Gc<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Trace + ?Sized + Ord> Ord for Gc<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: Trace + ?Sized + PartialEq> PartialEq for Gc<T>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Trace + ?Sized + PartialOrd> PartialOrd for Gc<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Trace + ?Sized> Pointer for Gc<T>

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

Formats the value using the given formatter.

impl<T: Trace + ?Sized> Trace for Gc<T>

unsafe fn trace(&self, tracer: &mut Tracer)

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

impl<T: Trace + ?Sized + Eq> Eq for Gc<T>