Struct ocaml_interop::OCamlRuntime

pub struct OCamlRuntime { /* private fields */ }

OCaml runtime handle.

Should be initialized once at the beginning of the program and the obtained handle passed around.

Once the handle is dropped, the OCaml runtime will be shutdown.

Implementations

impl OCamlRuntime

pub fn init() -> Self

Initializes the OCaml runtime and returns an OCaml runtime handle.

Once the handle is dropped, the OCaml runtime will be shutdown.

pub fn init_persistent()

Initializes the OCaml runtime.

After the first invocation, this method does nothing.

pub unsafe fn recover_handle() -> &'static mut Self

Recover the runtime handle.

This method is used internally, do not use directly in code, only when writing tests.

Safety

This function is unsafe because the OCaml runtime handle should be obtained once upon initialization of the OCaml runtime and then passed around. This method exists only to ease the authoring of tests.

pub fn releasing_runtime<T, F>(&mut self, f: F) -> T

where F: FnOnce() -> T,

Release the OCaml runtime lock, call f, and re-acquire the OCaml runtime lock.

pub fn get<'tmp, T>(&'tmp self, reference: OCamlRef<'_, T>) -> OCaml<'tmp, T>

Returns the OCaml valued to which this GC tracked reference points to.

Trait Implementations

impl Drop for OCamlRuntime

fn drop(&mut self)

Executes the destructor for this type.