Struct Heap

pub struct Heap {
    pub heap: Box<Heap>,
}

Wrapper over Comet heap.

Fields

heap: Box<Heap>

Implementations

impl Heap

pub fn defer(&self) -> DeferPoint

Creates GC defer point.

pub fn new(size: Option<usize>) -> Self

Creates new Comet heap. if size is < 1MB then it will be set to 1GB by default.

Examples found in repository

examples/simple.rs (line 36)

fn main() {
    GCPlatform::initialize();

    let mut heap = Heap::new(None);

    let mut head = heap.allocate(Node {next: None,value: 0i32 });
    head.next = Some(heap.allocate(Node {next: None, value: 1}));
    heap.gc();

    println!("{:p}",&head);
    head.next = None;
    heap.gc();
    println!("{:p}", &head);
}

pub fn gc(&mut self)

Triggers GC cycle.

Examples found in repository

examples/simple.rs (line 40)

fn main() {
    GCPlatform::initialize();

    let mut heap = Heap::new(None);

    let mut head = heap.allocate(Node {next: None,value: 0i32 });
    head.next = Some(heap.allocate(Node {next: None, value: 1}));
    heap.gc();

    println!("{:p}",&head);
    head.next = None;
    heap.gc();
    println!("{:p}", &head);
}

pub fn allocate_( &mut self, size: usize, vtable: usize, idx: GCInfoIndex, ) -> Option<NonNull<GcPointerBase>>

Allocates GcPointerBase in Comet heap with all internal fields initialized correctly

pub fn allocate_raw( &mut self, size: usize, vtable: usize, idx: GCInfoIndex, ) -> *mut GcPointerBase

Allocates raw memory in Comet heap.

pub fn allocate<T: GcCell + GCInfoTrait<T> + Trace + Finalize<T>>( &mut self, value: T, ) -> GcPointer<T>

Allocates T on the GC heap with initializing all data correctly.

Examples found in repository

examples/simple.rs (line 38)

fn main() {
    GCPlatform::initialize();

    let mut heap = Heap::new(None);

    let mut head = heap.allocate(Node {next: None,value: 0i32 });
    head.next = Some(heap.allocate(Node {next: None, value: 1}));
    heap.gc();

    println!("{:p}",&head);
    head.next = None;
    heap.gc();
    println!("{:p}", &head);
}

pub fn add_constraint(&mut self, constraint: impl MarkingConstraint + 'static)

Adds constraint to be executed before each gc cycle.

pub fn make_weak<T: GcCell>(&mut self, target: GcPointer<T>) -> WeakRef<T>

Allocates weak ref for T.

pub fn collect_if_necessary(&mut self)