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

//! Layout type for `Char`.
//!
//! In Rust it's unsafe to create an invalid `char`, while a `Char` in Julia can be an arbitrary
//! `u32` in some rare cases. Rather than treating all `Char`s as `u32` or `char`s, jlrs provides
//! a custom layout for this type, [`Char`].
use std::fmt::{Debug, Formatter, Result as FmtResult, Write};

use jl_sys::{jl_char_type, jl_unbox_uint32};

use super::is_bits::IsBits;
use crate::{
    convert::{ccall_types::CCallReturn, unbox::Unbox},
    data::managed::{private::ManagedPriv, value::Value},
    impl_julia_typecheck, impl_valid_layout,
    private::Private,
};

/// A Julia `Char`.
#[repr(C)]
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Char(u32);

impl Char {
    #[inline]
    pub const fn new(val: char) -> Self {
        Char(val as u32)
    }

    /// Returns the value of the `Char` as a `u32`.
    #[inline]
    pub const fn as_u32(self) -> u32 {
        self.0
    }

    /// Returns the value of the `Char` as a `char` if it's valid, `None` if it isn't.
    #[inline]
    pub const fn try_as_char(self) -> Option<char> {
        char::from_u32(self.0)
    }

    /// Returns the value of the `Char` as a `char`.
    ///
    /// Safety: the `Char` must be a valid `char`.
    #[inline]
    pub unsafe fn try_as_char_unchecked(self) -> char {
        unsafe { char::from_u32_unchecked(self.0) }
    }
}

impl<'scope> Debug for Char {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        if let Some(ch) = char::from_u32(self.0) {
            f.write_char(ch)
        } else {
            f.write_fmt(format_args!("{:#010x} <invalid char>", self.0))
        }
    }
}

impl_julia_typecheck!(Char, jl_char_type);
impl_valid_layout!(Char, jl_char_type);

unsafe impl Unbox for Char {
    type Output = Self;
    #[inline]
    unsafe fn unbox(value: Value) -> Char {
        unsafe { Char(jl_unbox_uint32(value.unwrap(Private).cast())) }
    }
}

unsafe impl Unbox for char {
    type Output = Char;
    #[inline]
    unsafe fn unbox(value: Value) -> Char {
        unsafe { Char(jl_unbox_uint32(value.unwrap(Private).cast())) }
    }
}

impl_ccall_arg!(Char);

unsafe impl CCallReturn for Char {
    type FunctionReturnType = Self;
    type CCallReturnType = Self;
    type ReturnAs = Self;

    #[inline]
    unsafe fn return_or_throw(self) -> Self::ReturnAs {
        self
    }
}

unsafe impl CCallReturn for char {
    type FunctionReturnType = Char;
    type CCallReturnType = Char;
    type ReturnAs = Char;

    #[inline]
    unsafe fn return_or_throw(self) -> Self::ReturnAs {
        Char(self as u32)
    }
}

impl_construct_julia_type!(Char, jl_char_type);

unsafe impl IsBits for Char {}