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

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

use jl_sys::{jl_bool_type, jl_unbox_int8};

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 `Bool`.
#[repr(C)]
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Bool(i8);

impl Bool {
    #[inline]
    pub fn new(val: bool) -> Self {
        Bool(val as i8)
    }

    #[inline]
    /// Returns the value of the `Bool` as a `i8`.
    pub fn as_i8(self) -> i8 {
        self.0
    }

    #[inline]
    /// Returns the value of the `Bool` as a `bool` if it's 0 or 1, `None` if it isn't.
    pub fn try_as_bool(self) -> Option<bool> {
        match self.0 {
            0 => Some(false),
            1 => Some(true),
            _ => None,
        }
    }

    /// Returns the value of the `Bool` as a `bool`.
    #[inline]
    pub fn as_bool(self) -> bool {
        self.0 != 0
    }
}

impl<'scope> Debug for Bool {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self.as_i8() {
            0 => f.write_str("false"),
            1 => f.write_str("true"),
            n => f.write_fmt(format_args!("{} <invalid bool>", n)),
        }
    }
}

impl_julia_typecheck!(Bool, jl_bool_type);
impl_valid_layout!(Bool, jl_bool_type);

unsafe impl Unbox for Bool {
    type Output = Self;

    #[inline]
    unsafe fn unbox(value: Value) -> Bool {
        unsafe { Bool(jl_unbox_int8(value.unwrap(Private).cast())) }
    }
}

unsafe impl Unbox for bool {
    type Output = Bool;

    #[inline]
    unsafe fn unbox(value: Value) -> Bool {
        unsafe { Bool(jl_unbox_int8(value.unwrap(Private).cast())) }
    }
}

impl_ccall_arg!(Bool);

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

    #[inline]
    unsafe fn return_or_throw(self) -> Self::ReturnAs {
        self
    }
}
unsafe impl CCallReturn for bool {
    type FunctionReturnType = Bool;
    type CCallReturnType = Bool;
    type ReturnAs = Bool;

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

impl_construct_julia_type!(Bool, jl_bool_type);

unsafe impl IsBits for Bool {}