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
58
59
60
61
62
63
64
65
66
67

#![feature(generic_param_attrs)]
#![feature(dropck_eyepatch)]

/// This module lets you create garbage-collected scopes
///
/// ```compile_fail
/// use scoped_gc::{Gc, GcScope, Trace};
///
/// pub struct NamedObject {
///   pub name: String,
/// }
///
/// impl Trace for NamedObject {
///   fn trace(&self) {}
///   fn root(&self) {}
///   fn unroot(&self) {}
/// }
///
/// fn main() {
///   let message: Gc<NamedObject>;
///   {
///     let scope: GcScope = GcScope::new();
///     message = scope.alloc(NamedObject { name: String::from("Hello, World!") }).unwrap();
///   }
///   println!("{}", message.name);
/// }
/// ```
///
/// ```compile_fail
/// use scoped_gc::{Gc, GcScope, Trace};
///
/// pub struct RefNamedObject<'a> {
///   pub name: &'a str,
/// }
///
/// impl<'a> Trace for RefNamedObject<'a> {
///   fn trace(&self) {}
///   fn root(&self) {}
///   fn unroot(&self) {}
/// }
///
/// fn main() {
///   let scope: GcScope = GcScope::new();
///   let message: Gc<RefNamedObject>;
///   {
///     let hello_world: String = String::from("Hello, World!");
///     message = scope.alloc(RefNamedObject { name: &hello_world }).unwrap();
///   }
/// }
/// ```

mod gc;
mod gc_alloc_err;
mod gc_box;
mod gc_ref_cell;
mod gc_scope;
mod gc_state;
mod trace;

#[cfg(test)]
mod test;

pub use gc::Gc;
pub use gc_alloc_err::GcAllocErr;
pub use gc_ref_cell::{GcRef, GcRefCell, GcRefMut};
pub use gc_scope::GcScope;
pub use trace::Trace;