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
162
163
164
165
166
167
168
169
170
171

//! Tracked Julia data.
//!
//! Tracking data is the only way to get a (mutable) reference to Julia data in jlrs. Data can be
//! tracked mutably or immutably with [`Value::track_shared`] and [`Value::track_exclusive`].

use std::{
    marker::PhantomData,
    ops::{Deref, DerefMut},
    ptr::NonNull,
};

use jl_sys::jl_value_t;

use crate::{
    data::{
        layout::valid_layout::ValidLayout,
        managed::{private::ManagedPriv, value::Value},
    },
    memory::context::ledger::Ledger,
    private::Private,
};

/// Immutable tracked data.
#[repr(transparent)]
pub struct Tracked<'tracked, 'scope, 'data, T> {
    tracked: &'tracked T,
    _s: PhantomData<&'scope ()>,
    _d: PhantomData<&'data ()>,
}

impl<'tracked, 'scope, 'data, T: ValidLayout> Tracked<'tracked, 'scope, 'data, T> {
    #[inline]
    pub(crate) unsafe fn new(value: &'tracked Value<'scope, 'data>) -> Self {
        unsafe {
            Tracked {
                tracked: value.data_ptr().cast::<T>().as_ref(),
                _s: PhantomData,
                _d: PhantomData,
            }
        }
    }
}

impl<'scope, 'data, T: ValidLayout> Tracked<'scope, 'scope, 'data, T> {
    #[inline]
    pub(crate) unsafe fn new_owned(value: Value<'scope, 'data>) -> Self {
        unsafe {
            Tracked {
                tracked: value.data_ptr().cast::<T>().as_ref(),
                _s: PhantomData,
                _d: PhantomData,
            }
        }
    }
}

impl<'tracked, 'scope, 'data, T: ValidLayout> Deref for Tracked<'tracked, 'scope, 'data, T> {
    type Target = T;

    #[inline]
    fn deref(&self) -> &Self::Target {
        self.tracked
    }
}

unsafe impl<'tracked, 'scope, 'data, T: ValidLayout + Send> Send
    for Tracked<'tracked, 'scope, 'data, T>
{
}

impl<T> Clone for Tracked<'_, '_, '_, T> {
    fn clone(&self) -> Self {
        unsafe {
            let v = Value::wrap_non_null(
                NonNull::new_unchecked(self.tracked as *const _ as *mut jl_value_t),
                Private,
            );

            if v.datatype().mutable() {
                Ledger::try_borrow_shared(v).unwrap();
            }
        }
        Self {
            tracked: self.tracked,
            _s: PhantomData,
            _d: PhantomData,
        }
    }
}

impl<T> Drop for Tracked<'_, '_, '_, T> {
    fn drop(&mut self) {
        unsafe {
            let v = Value::wrap_non_null(
                NonNull::new_unchecked(self.tracked as *const _ as *mut jl_value_t),
                Private,
            );

            if v.datatype().mutable() {
                Ledger::unborrow_shared(v).unwrap();
            }
        }
    }
}

/// Mutable tracked data.
#[repr(transparent)]
pub struct TrackedMut<'tracked, 'scope, 'data, T: ValidLayout> {
    t: &'tracked mut T,
    _s: PhantomData<&'scope ()>,
    _d: PhantomData<&'data ()>,
}

impl<'tracked, 'scope, 'data, T: ValidLayout> TrackedMut<'tracked, 'scope, 'data, T> {
    #[inline]
    pub(crate) unsafe fn new(value: &'tracked mut Value<'scope, 'data>) -> Self {
        unsafe {
            TrackedMut {
                t: value.data_ptr().cast::<T>().as_mut(),
                _s: PhantomData,
                _d: PhantomData,
            }
        }
    }
}

impl<'scope, 'data, T: ValidLayout> TrackedMut<'scope, 'scope, 'data, T> {
    #[inline]
    pub(crate) unsafe fn new_owned(value: Value<'scope, 'data>) -> Self {
        unsafe {
            TrackedMut {
                t: value.data_ptr().cast::<T>().as_mut(),
                _s: PhantomData,
                _d: PhantomData,
            }
        }
    }
}

impl<'tracked, 'scope, 'data, T: ValidLayout> Deref for TrackedMut<'tracked, 'scope, 'data, T> {
    type Target = T;

    #[inline]
    fn deref(&self) -> &Self::Target {
        self.t
    }
}

impl<'tracked, 'scope, 'data, T: ValidLayout> DerefMut for TrackedMut<'tracked, 'scope, 'data, T> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.t
    }
}

unsafe impl<'tracked, 'scope, 'data, T: ValidLayout + Send> Send
    for TrackedMut<'tracked, 'scope, 'data, T>
{
}

impl<T: ValidLayout> Drop for TrackedMut<'_, '_, '_, T> {
    fn drop(&mut self) {
        unsafe {
            let v = Value::wrap_non_null(
                NonNull::new_unchecked(self.t as *mut _ as *mut jl_value_t),
                Private,
            );
            Ledger::unborrow_exclusive(v).unwrap();
        }
    }
}