cabbage_collector 0.1.1

ready
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
50
51
52
53
54
55
56
57

# Cabbage Collector

- Simple GC implementation
- Simple Mark and Sweep

## Guide

The way to create and use the object is almost the same as `Box<T>`.
However, in the current implementation, GC must be triggered manually.

```rust
    {
        #[derive(Debug, Clone)]
        struct A {
            pub value: i32,
        }

        let child_obj = CabbageBox::new(A { value: 1 });
        println!("{:?}", child_obj);
    }
    COLLECTOR.run_cabbage_collection();
```

The circular reference issue has been resolved.

```rust
    {
        #[derive(Debug, Clone)]
        struct A {
            pub value: Option<CabbageBox<B>>,
        }

        #[derive(Debug, Clone)]
        struct B {
            pub value: Option<CabbageBox<A>>,
        }

        let mut a_obj = CabbageBox::new(A { value: None });
        let mut b_obj = CabbageBox::new(B { value: None });

        a_obj.value = Some(b_obj.clone());
        a_obj.adopt_child(b_obj.clone());

        b_obj.value = Some(a_obj.clone());
        b_obj.adopt_child(a_obj.clone());
    }
    COLLECTOR.run_cabbage_collection();
```

## Checklist

- [x] Circular Reference
- [ ] Automatically identifies root and non-root
- [ ] Auto trigger GC
- [ ] Concurrent GC
- [ ] Generational GC
- [ ] Memory Compaction