ghost-gc 0.2.1

A safe garbage collected arena.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

#![feature(ptr_metadata, allocator_api)]
#![deny(unsafe_op_in_unsafe_fn)]
#![doc = include_str!("../README.md")]

extern crate alloc;

mod arena;
mod collect;
mod context;
mod gc;
mod gc_vtable;
mod unique_gc;
mod write;

mod gc_box;
mod gc_weak;
mod invariant;
pub mod locked;

pub use arena::{Arena, Rootable};
pub use collect::Collect;
pub use context::{Collector, Mutation};
pub use gc::Gc;
pub use gc_weak::Weak;
pub use unique_gc::UniqueGc;
pub use write::Write;

use invariant::Invariant;

pub fn once_arena<F, R>(f: F) -> R
where
    F: for<'b> FnOnce(&Mutation<'b>) -> R,
{
    struct OnceRoot;

    impl Rootable for OnceRoot {
        type Root<'a> = OnceRoot;
    }

    unsafe impl Collect for OnceRoot {
        const NEEDS_TRACE: bool = false;

        fn trace(&self, _c: &Collector) {}
    }

    let arena = Arena::<OnceRoot>::new(|_| OnceRoot);

    arena.view(|_, mt| f(mt))
}