Struct pgc::Gc

pub struct Gc<T: ?Sized + GcObject> { /* fields omitted */ }

A garbage-collected pointer type

Methods

impl<T: Sized + GcObject + 'static> Gc<T>

pub fn new(val: T) -> Self

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

Collection

This method could trigger a garbage collection.

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

pub fn get(&self) -> &T

Get reference to data

pub fn get_mut(&self) -> &mut T

Get mutable reference to data. WARNING: Should be used carefully since Rust does not allows two mutable pointers to same data.

pub fn ref_eq(&self, other: Gc<dyn GcObject>) -> bool

Compares two pointers

Trait Implementations

impl<T: GcObject + 'static> GcObject for Gc<T>

fn references(&self) -> Vec<Gc<dyn GcObject>>

impl<T: ?Sized + GcObject> Send for Gc<T>

impl<T: Eq + PartialEq + GcObject> Eq for Gc<T>

impl<T: ?Sized + GcObject + Sync> Sync for Gc<T>

impl<T: ?Sized + GcObject> 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: PartialOrd + GcObject> PartialOrd<Gc<T>> for Gc<T>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl<T: PartialEq + GcObject> PartialEq<Gc<T>> for Gc<T>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd + Ord + GcObject> 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

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) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: GcObject + 'static> From<Rooted<T>> for Gc<T>

fn from(x: Rooted<T>) -> Self

Performs the conversion.

impl<T: ?Sized + GcObject> Copy for Gc<T>

impl<T: GcObject + ?Sized + Unsize<U>, U: GcObject + ?Sized> CoerceUnsized<Gc<U>> for Gc<T>

impl<T: Hash + GcObject> 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, 

Feeds a slice of this type into the given [Hasher].

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Debug + GcObject> Debug for Gc<T>

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

Formats the value using the given formatter.

impl<T: Display + GcObject> Display for Gc<T>

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

Formats the value using the given formatter.