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

//! Convert strings to symbols.
//!
//! Many things in Julia are accessed with [`Symbol`]s, the [`ToSymbol`] trait allows for
//! strings to be used instead.

use std::marker::PhantomData;

use crate::{
    data::managed::{
        string::JuliaString,
        symbol::{
            Symbol,
            static_symbol::{StaticSymbol, Sym},
        },
    },
    memory::target::Target,
    private::Private,
};

/// Trait implemented by types that can be converted to a [`Symbol`].
pub trait ToSymbol: private::ToSymbolPriv {
    /// Convert `self` to a `Symbol`.
    ///
    /// This method only needs a reference to a target because `Symbol` are globally rooted.
    #[inline]
    fn to_symbol<'target, Tgt: Target<'target>>(&self, _: &Tgt) -> Symbol<'target> {
        // Safety: Requiring a reference to a target guarantees this method can only be called
        // from a thread known to Julia.
        unsafe { self.to_symbol_priv(Private) }
    }
}

impl<T: AsRef<str>> ToSymbol for T {}
impl ToSymbol for Symbol<'_> {}
impl ToSymbol for JuliaString<'_> {}
impl<S: StaticSymbol> ToSymbol for Sym<'_, PhantomData<S>> {}
impl<S: StaticSymbol> ToSymbol for Sym<'_, S> {}

pub(crate) mod private {
    use std::marker::PhantomData;

    use super::{StaticSymbol, Sym};
    use crate::{
        data::managed::{private::ManagedPriv, string::JuliaString, symbol::Symbol},
        memory::target::unrooted::Unrooted,
        private::Private,
    };

    pub trait ToSymbolPriv {
        // Safety: this method must only be called from a thread known to Julia
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol>;
    }

    impl<T: AsRef<str>> ToSymbolPriv for T {
        #[inline]
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol> {
            unsafe {
                let unrooted = Unrooted::new();
                Symbol::new(&unrooted, self)
            }
        }
    }

    impl<S: StaticSymbol> ToSymbolPriv for Sym<'_, S> {
        #[inline]
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol> {
            unsafe {
                let unrooted = Unrooted::new();
                S::get_symbol(&unrooted)
            }
        }
    }

    impl<S: StaticSymbol> ToSymbolPriv for Sym<'_, PhantomData<S>> {
        #[inline]
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol> {
            unsafe {
                let unrooted = Unrooted::new();
                S::get_symbol(&unrooted)
            }
        }
    }

    impl ToSymbolPriv for JuliaString<'_> {
        #[inline]
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol> {
            unsafe {
                let symbol_ptr = self.as_bytes();
                let unrooted = Unrooted::new();
                Symbol::new_bytes(&unrooted, symbol_ptr).unwrap()
            }
        }
    }

    impl ToSymbolPriv for Symbol<'_> {
        #[inline]
        unsafe fn to_symbol_priv<'symbol>(&self, _: Private) -> Symbol<'symbol> {
            unsafe { Symbol::wrap_non_null(self.unwrap_non_null(Private), Private) }
        }
    }
}