Struct zerogc_simple::Gc

pub struct Gc<'gc, T: GcSafe + 'gc> { /* fields omitted */ }

A garbage collected pointer

See docs for zerogc::GcRef

Trait Implementations

impl<'gc, T: GcSafe + 'gc> Clone for Gc<'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<'gc, T: GcSafe + 'gc> Copy for Gc<'gc, T>

impl<'gc, T: GcSafe + Debug + 'gc> Debug for Gc<'gc, T>

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

Formats the value using the given formatter.

impl<'gc, T: GcSafe + 'gc> Deref for Gc<'gc, T>

type Target = &'gc T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'gc, T: GcSafe + Eq + 'gc> Eq for Gc<'gc, T>

impl<'gc, 'new_gc, T> GcBrand<'new_gc, SimpleCollector> for Gc<'gc, T> where
    T: GcSafe + GcBrand<'new_gc, SimpleCollector>,
    T::Branded: GcSafe, 

Rebrand

type Branded = Gc<'new_gc, <T as GcBrand<'new_gc, SimpleCollector>>::Branded>

This type with all garbage collected lifetimes changed to 'new_gc

impl<'gc, T> GcCreateHandle<'gc, T> for Gc<'gc, T> where
    T: GcSafe,
    T: GcBrand<'static, SimpleCollector>,
    T::Branded: GcSafe, 

We support handles

type Handle = GcHandle<T::Branded>

The type of handles to this object.

fn create_handle(&self) -> Self::Handle

Create a handle to this object, which can be used without a context

impl<'gc, T, V> GcDirectBarrier<'gc, Gc<'gc, T>> for Gc<'gc, V> where
    T: GcSafe + 'gc,
    V: GcSafe + 'gc, 

Simple GC doesn't need write barriers :)

This implementation is just for writing Gc<T> -> Gc<T>

unsafe fn write_barrier(&self, _owner: &Gc<'gc, T>, _field_offset: usize)

Trigger a write barrier, before writing to one of the owning object's managed fields

impl<'gc, T: GcSafe + 'gc> GcRef<'gc, T> for Gc<'gc, T>

type System = SimpleCollector

The type of the garbage collection system that created this pointer

fn value(&self) -> &'gc T

The value of the underlying pointer

unsafe fn as_raw_ptr(&self) -> *mut T

Cast this reference to a raw pointer

impl<'gc, T: GcSafe + 'gc> GcSafe for Gc<'gc, T>

Double-indirection is completely safe

const NEEDS_DROP: bool

If this type needs a destructor run

impl<'gc, T: GcSafe + Hash + 'gc> Hash for Gc<'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<'gc, T: GcSafe + PartialEq + 'gc> PartialEq<Gc<'gc, T>> for Gc<'gc, T>

fn eq(&self, other: &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<'gc, T: GcSafe + PartialEq + 'gc> PartialEq<T> for Gc<'gc, T>

fn eq(&self, other: &T) -> 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<'gc, T: GcSafe + Sync> Send for Gc<'gc, T>

In order to send references between threads, the underlying type must be sync.

This is the same reason that Arc<T>: Send requires T: Sync

impl<'gc, T: GcSafe + Sync> Sync for Gc<'gc, T>

If the underlying type is Sync, it's safe to share garbage collected references between threads.

The collector itself is always safe :D

impl<'gc, T: GcSafe + 'gc> Trace for Gc<'gc, T>

const NEEDS_TRACE: bool

Whether this type needs to be traced by the garbage collector.

fn visit<V: GcVisitor>(&mut self, visitor: &mut V) -> Result<(), V::Err>

Visit each field in this type