Add some docs. Tests for Value constants

jl_sys/build.rs

@@ -126,6 +126,7 @@ fn main() {
         .whitelist_function("jl_init__threading")
         .whitelist_function("jl_init_with_image__threading")
         .whitelist_function("jl_is_initialized")
+        .whitelist_function("jl_isa")
         .whitelist_function("jl_islayout_inline")
         .whitelist_function("jl_new_array")
         .whitelist_function("jl_new_struct_uninit")

jlrs/src/lib.rs

@@ -406,7 +406,6 @@ macro_rules! named_tuple {
 
 pub mod error;
 pub mod frame;
-pub mod gc;
 pub mod global;
 #[doc(hidden)]
 pub mod jl_sys_export;

jlrs/src/traits.rs

@@ -34,6 +34,7 @@
 pub mod bits_union;
 pub mod cast;
 pub mod frame;
+pub mod gc;
 pub mod into_julia;
 pub mod julia_type;
 pub mod julia_typecheck;
@@ -45,6 +46,7 @@ pub mod valid_layout;
 pub use bits_union::{Align, BitsUnion, Flag};
 pub use cast::Cast;
 pub use frame::Frame;
+pub use gc::Gc;
 pub use into_julia::IntoJulia;
 pub use julia_type::JuliaType;
 pub use julia_typecheck::JuliaTypecheck;

jlrs/src/traits/bits_union.rs

@@ -1,3 +1,5 @@
+//! Machinery for bits unions.
+
 /// Trait implemented by the aligning structs, which ensure bits unions are properly aligned.
 /// Used in combination with `BitsUnion` and `Flag` to ensure bits unions are inserted correctly.
 pub unsafe trait Align {

jlrs/src/traits/cast.rs

@@ -1,3 +1,5 @@
+//! Convert a `Value` to another type.
+
 use crate::error::{JlrsError, JlrsResult};
 use crate::value::Value;
 use jl_sys::{

jlrs/src/gc.rs → jlrs/src/traits/gc.rs

@@ -1,24 +1,30 @@
-use jl_sys::{jl_gc_collect, jl_gc_collection_t, jl_gc_enable, jl_gc_is_enabled};
+//! Control the garbage collector.
 
 use crate::traits::Frame;
 use crate::Julia;
+use jl_sys::{jl_gc_collect, jl_gc_collection_t, jl_gc_enable, jl_gc_is_enabled};
 
+/// The different collection modes.
 #[derive(Debug, Copy, Clone)]
 pub enum GcCollection {
     Auto = 0,
     Full = 1,
     Incremental = 2,
 }
 
-pub trait Gc: private::Sealed {
+/// This trait is used to enable and disable the garbage collector and to force a collection.
+pub trait Gc: private::Gc {
+    /// Enable or disable the GC.
     unsafe fn enable_gc(&mut self, on: bool) -> bool {
         jl_gc_enable(on as i32) == 1
     }
 
+    /// Returns `true` if the GC is enabled.
     fn gc_is_enabled(&mut self) -> bool {
         unsafe { jl_gc_is_enabled() == 1 }
     }
 
+    /// Force a collection.
     unsafe fn gc_collect(&mut self, mode: GcCollection) {
         jl_gc_collect(mode as jl_gc_collection_t)
     }
@@ -29,7 +35,7 @@ impl<'frame, T: Frame<'frame>> Gc for T {}
 
 mod private {
     use super::{Frame, Julia};
-    pub trait Sealed {}
-    impl<'a, T: Frame<'a>> Sealed for T {}
-    impl Sealed for Julia {}
+    pub trait Gc {}
+    impl<'a, T: Frame<'a>> Gc for T {}
+    impl Gc for Julia {}
 }

jlrs/src/value.rs

@@ -35,11 +35,11 @@ use jl_sys::{
     jl_diverror_exception, jl_egal, jl_emptytuple, jl_eval_string, jl_exception_occurred, jl_false,
     jl_field_index, jl_field_isptr, jl_field_names, jl_fieldref, jl_fieldref_noalloc, jl_finalize,
     jl_gc_add_finalizer, jl_get_kwsorter, jl_get_nth_field, jl_get_nth_field_noalloc,
-    jl_interrupt_exception, jl_is_kind, jl_memory_exception, jl_new_array, jl_new_struct_uninit,
-    jl_new_structv, jl_nfields, jl_nothing, jl_object_id, jl_ptr_to_array, jl_ptr_to_array_1d,
-    jl_readonlymemory_exception, jl_set_nth_field, jl_stackovf_exception, jl_subtype, jl_svec_data,
-    jl_svec_len, jl_true, jl_type_union, jl_type_unionall, jl_typeof, jl_typeof_str,
-    jl_undefref_exception, jl_value_t,
+    jl_interrupt_exception, jl_is_kind, jl_isa, jl_memory_exception, jl_new_array,
+    jl_new_struct_uninit, jl_new_structv, jl_nfields, jl_nothing, jl_object_id, jl_ptr_to_array,
+    jl_ptr_to_array_1d, jl_readonlymemory_exception, jl_set_nth_field, jl_stackovf_exception,
+    jl_subtype, jl_svec_data, jl_svec_len, jl_true, jl_type_union, jl_type_unionall, jl_typeof,
+    jl_typeof_str, jl_undefref_exception, jl_value_t,
 };
 use std::borrow::BorrowMut;
 use std::ffi::{CStr, CString};
@@ -653,6 +653,10 @@ impl<'frame, 'data> Value<'frame, 'data> {
     pub fn object_id(self) -> usize {
         unsafe { jl_object_id(self.ptr()) }
     }
+
+    pub fn isa(self, other: Value) -> bool {
+        unsafe { jl_isa(self.ptr(), other.ptr()) != 0 }
+    }
 }
 
 /// # Type checking

jlrs/tests/borrow_array_data.rs

@@ -1,5 +1,5 @@
-use jlrs::gc::{Gc, GcCollection};
 use jlrs::prelude::*;
+use jlrs::traits::gc::{Gc, GcCollection};
 use jlrs::util::JULIA;
 
 macro_rules! impl_test {