gc-alloc 0.2.1

A Rust library for garbage-collected memory allocation using libgc (bdwgc).
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

use crate::{gc, private};

pub trait GcToken: private::Sealed {}

pub struct ThreadToken {
    _non_send: std::marker::PhantomData<*const ()>,
}

impl private::Sealed for ThreadToken {}
impl GcToken for ThreadToken {}

impl ThreadToken {
    pub(crate) fn new() -> Self {
        Self {
            _non_send: std::marker::PhantomData,
        }
    }

    pub fn get() -> Self {
        Self::try_get()
            .expect("Thread is not registered with the GC. Please call init_thread() first.")
    }

    pub fn try_get() -> Option<Self> {
        if crate::GC_REGISTERED.get() {
            Some(ThreadToken {
                _non_send: std::marker::PhantomData,
            })
        } else {
            None
        }
    }
}

pub struct ThreadGuard {
    _non_send: std::marker::PhantomData<*const ()>,
}

impl private::Sealed for ThreadGuard {}
impl GcToken for ThreadGuard {}

impl ThreadGuard {
    pub(crate) fn new() -> Self {
        Self {
            _non_send: std::marker::PhantomData,
        }
    }
}

impl Drop for ThreadGuard {
    fn drop(&mut self) {
        unsafe { gc::GC_unregister_my_thread() };
    }
}