Struct mun_memory::gc::MarkSweep

pub struct MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event>,  { /* fields omitted */ }

Implements a simple mark-sweep type garbage collector.

Implementations

impl<T, O> MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event>, 

pub fn with_observer(observer: O) -> Self

Creates a MarkSweep memory collector with the specified Observer.

pub fn observer(&self) -> &O

Returns the observer

impl<T, O> MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event>, 

pub fn collect(&self) -> bool

Collects all memory that is no longer referenced by rooted objects. Returns true if memory was reclaimed, false otherwise.

Trait Implementations

impl<T: Debug, O: Debug> Debug for MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event>, 

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

Formats the value using the given formatter.

impl<T, O> Default for MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event> + Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<T, O> GcRuntime<T> for MarkSweep<T, O> where
    T: TypeMemory + TypeTrace + Clone,
    O: Observer<Event = Event>, 

fn alloc(&self, ty: T) -> GcPtr

Allocates an object of the given type returning a GcPtr

fn ptr_type(&self, handle: GcPtr) -> T

Returns the type of the specified obj.

fn root(&self, handle: GcPtr)

Roots the specified obj, which keeps it and objects it references alive. Objects marked as root, must call unroot before they can be collected. An object can be rooted multiple times, but you must make sure to call unroot an equal number of times before the object can be collected.

fn unroot(&self, handle: GcPtr)

Unroots the specified obj, potentially allowing it and objects it references to be collected. An object can be rooted multiple times, so you must make sure to call unroot the same number of times as root was called before the object can be collected.

fn stats(&self) -> Stats

Returns stats about the current state of the runtime.

impl<T, O> MemoryMapper<T> for MarkSweep<T, O> where
    T: TypeDesc + TypeMemory + TypeTrace + Clone + Eq + Hash,
    O: Observer<Event = Event>, 

fn map_memory(&self, mapping: Mapping<T, T>) -> Vec<GcPtr>

Maps its allocated memory using the provided mapping.