Struct boa_gc::Gc

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

A garbage-collected pointer type over an immutable value.

See the module level documentation for more details.

Implementations

impl<T> Gc<T>where
    T: Trace,

pub fn new(value: T) -> Gc<T>

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

Collection

This method could trigger a garbage collection.

Examples

use gc::Gc;

let five = Gc::new(5);
assert_eq!(*five, 5);

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

pub fn ptr_eq(this: &Gc<T>, other: &Gc<T>) -> bool

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

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

pub fn into_raw(this: Gc<T>) -> *const T

Consumes the Gc, returning the wrapped pointer.

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

Examples

use gc::Gc;

let x = Gc::new(22);
let x_ptr = Gc::into_raw(x);
assert_eq!(unsafe { *x_ptr }, 22);

pub unsafe fn from_raw(ptr: *const T) -> Gc<T>

Constructs an Gc from a raw pointer.

The raw pointer must have been previously returned by a call to a Gc::into_raw.

This function is unsafe because improper use may lead to memory problems. For example, a use-after-free will occur if the function is called twice on the same raw pointer.

Examples

use gc::Gc;

let x = Gc::new(22);
let x_ptr = Gc::into_raw(x);

unsafe {
    // Convert back to an `Gc` to prevent leak.
    let x = Gc::from_raw(x_ptr);
    assert_eq!(*x, 22);

    // Further calls to `Gc::from_raw(x_ptr)` would be memory unsafe.
}

// The memory can be freed at any time after `x` went out of scope above
// (when the collector is run), which would result in `x_ptr` dangling!

Trait Implementations

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

fn as_ref(&self) -> &T

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

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

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

fn clone(&self) -> Gc<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Gc<T>

Returns the “default value” for a type.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn finalize(&self)

impl<T> From<T> for Gc<T>where
    T: Trace,

fn from(t: T) -> Gc<T>

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

fn cmp(&self, other: &Gc<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

fn eq(&self, other: &Gc<T>) -> 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> PartialOrd<Gc<T>> for Gc<T>where
    T: Trace + PartialOrd<T> + ?Sized,

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

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

fn lt(&self, other: &Gc<T>) -> bool

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

fn le(&self, other: &Gc<T>) -> bool

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

fn gt(&self, other: &Gc<T>) -> bool

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

fn ge(&self, other: &Gc<T>) -> bool

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

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

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

Formats the value using the given formatter.

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

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn root(&self)

Increments the root-count of all contained Gcs.

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

fn finalize_glue(&self)

Runs Finalize::finalize() on this object and all contained subobjects

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