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

//! ocaml-rs is a library for directly interacting with the C OCaml runtime, in Rust.
//!
//! **Note:** `ocaml-rs` is still experimental, please report any issues on [github](https://github.com/zshipko/ocaml-rs/issues)
//!
//! This crate will allow you to write OCaml C stubs directly in Rust. It is suggested to build
//! a static library to link to when compiling your OCaml code.
//!
//! The following in Rust:
//!
//! ```norun
//! caml!(ml_add_10(arg) {
//!     caml_local!(x);
//!     let n = arg.i32_val();
//!     x = Value::i32(n + 10);
//!     return x;
//! });
//! ```
//!
//! is equivalent to:
//!
//! ```c
//! value ml_add_10(value arg) {
//!     CAMLparam1(arg);
//!     CAMLlocal(result);
//!     int n = Int_val(arg);
//!     result = Val_int(arg + 10)
//!     CAMLreturn(result);
//! }
//! ```
//!
//! using the traditional C bindings.
//!
//! Here are a few more examples...
//!
//! ```norun
//! caml!(build_tuple(i) {
//!     let i = i.val_i32();
//!     Tuple::from(&[i + 1, i + 2, i + 3])
//! });
//!
//! caml!(average(arr) {
//!     let arr = Array::from(arr);
//!     let len = arr.len();
//!     let sum = 0f64;
//!
//!     for i in 0..len {
//!         sum += arr.get_double_unchecked(i);
//!     }
//!
//!     Value::f64(sum / len as f64)
//! });
//! ```
//!
//! In OCaml the stubs for these functions looks like this:
//!
//! ```ocaml
//! external build_tuple: int -> int * int * int = "build_tuple"
//! external average: float array -> float = "average"
//! ```
//!
//! For more examples see [./example](https://github.com/zshipko/ocaml-rs/blob/master/example)
//! or [ocaml-vec](https://github.com/zshipko/ocaml-vec).

#[macro_use]
mod macros;

#[macro_use]
pub mod core;
pub mod conv;
mod error;
mod named;
pub mod runtime;
mod tag;
mod types;
pub mod value;

pub use crate::error::Error;
pub use crate::named::named_value;
pub use crate::runtime::*;
pub use crate::tag::Tag;
pub use crate::types::{Array, Array1, List, Str, Tuple};
pub use crate::value::{FromValue, ToValue, Value};