jlrs 0.23.0

jlrs provides bindings to the Julia C API that enable Julia code to be called from Rust and more.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

//! A GC-safe `OnceLock`.
//!
//! The API matches that of [`once_cell::sync::OnceCell`].

use std::fmt;

use jlrs_sys::{
    jlrs_gc_safe_enter, jlrs_gc_safe_leave, jlrs_gc_unsafe_enter, jlrs_gc_unsafe_leave,
};
use once_cell::sync::OnceCell;

use crate::memory::get_tls;

/// A GC-safe `OnceLock`. See [`once_cell::sync::OnceCell`] for more information.
#[derive(Clone)]
pub struct GcSafeOnceLock<T> {
    inner: OnceCell<T>,
}

impl<T> Default for GcSafeOnceLock<T> {
    fn default() -> GcSafeOnceLock<T> {
        GcSafeOnceLock::new()
    }
}

impl<T: fmt::Debug> fmt::Debug for GcSafeOnceLock<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.inner.fmt(f)
    }
}

impl<T> From<T> for GcSafeOnceLock<T> {
    fn from(value: T) -> Self {
        Self::with_value(value)
    }
}

impl<T: PartialEq> PartialEq for GcSafeOnceLock<T> {
    fn eq(&self, other: &GcSafeOnceLock<T>) -> bool {
        self.get() == other.get()
    }
}

impl<T: Eq> Eq for GcSafeOnceLock<T> {}

impl<T> GcSafeOnceLock<T> {
    #[inline]
    pub const fn new() -> Self {
        GcSafeOnceLock {
            inner: OnceCell::new(),
        }
    }

    /// Creates a new initialized cell.
    #[inline]
    pub const fn with_value(value: T) -> GcSafeOnceLock<T> {
        GcSafeOnceLock {
            inner: OnceCell::with_value(value),
        }
    }

    #[inline]
    pub fn get(&self) -> Option<&T> {
        self.inner.get()
    }

    #[inline]
    pub fn wait(&self) -> &T {
        unsafe {
            let ptls = get_tls();
            let state = jlrs_gc_safe_enter(ptls);
            let res = self.inner.wait();
            jlrs_gc_safe_leave(ptls, state);
            res
        }
    }

    #[inline]
    pub fn get_mut(&mut self) -> Option<&mut T> {
        self.inner.get_mut()
    }

    #[inline]
    pub unsafe fn get_unchecked(&self) -> &T {
        unsafe { self.inner.get_unchecked() }
    }

    #[inline]
    pub fn set(&self, value: T) -> Result<(), T> {
        unsafe {
            let ptls = get_tls();
            let state = jlrs_gc_safe_enter(ptls);
            let res = self.inner.set(value);
            jlrs_gc_safe_leave(ptls, state);
            res
        }
    }

    #[inline]
    pub fn try_insert(&self, value: T) -> Result<&T, (&T, T)> {
        self.inner.try_insert(value)
    }

    pub fn get_or_init<F>(&self, f: F) -> &T
    where
        F: FnOnce() -> T,
    {
        if let Some(v) = self.get() {
            return v;
        }

        unsafe {
            let ptls = get_tls();
            let state = jlrs_gc_safe_enter(ptls);

            let res = self.inner.get_or_init(|| {
                let state = jlrs_gc_unsafe_enter(ptls);
                let res = f();
                jlrs_gc_unsafe_leave(ptls, state);
                res
            });

            jlrs_gc_safe_leave(ptls, state);
            res
        }
    }

    pub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E>
    where
        F: FnOnce() -> Result<T, E>,
    {
        if let Some(v) = self.get() {
            return Ok(v);
        }

        unsafe {
            let ptls = get_tls();
            let state = jlrs_gc_safe_enter(ptls);

            let res = self.inner.get_or_try_init(|| {
                let state = jlrs_gc_unsafe_enter(ptls);
                let res = f();
                jlrs_gc_unsafe_leave(ptls, state);
                res
            });

            jlrs_gc_unsafe_leave(ptls, state);
            res
        }
    }

    #[inline]
    pub fn take(&mut self) -> Option<T> {
        self.inner.take()
    }

    #[inline]
    pub fn into_inner(self) -> Option<T> {
        self.inner.into_inner()
    }
}