Struct ocaml_interop::OCaml

pub struct OCaml<'a, T: 'a> { /* private fields */ }

Representation of OCaml values.

Implementations

impl<'a, T> OCaml<'a, T>

pub fn as_ref<'b>(&'b self) -> OCamlRef<'b, T>

where 'a: 'b,

Obtains an OCamlRef<T> for this value.

pub fn root(self) -> BoxRoot<T>

pub unsafe fn raw(&self) -> RawOCaml

Gets the raw representation for this value reference (pointer or int).

Safety

The resulting raw pointer will not be tracked, and may become invalid after any call into the OCaml runtime. Great care must be taken when working with these values.

pub fn to_rust<RustT>(&self) -> RustT

where RustT: FromOCaml<T>,

Converts this OCaml value into a Rust value.

pub unsafe fn custom_ptr_val<U>(&self) -> *const U

Meant to match Data_custom_val from mlvalues.h

Experimental

Safety

Casts to an arbitrary pointer type, take care before dereferencing

Similar to raw(), the resulting pointer can become invalid after any call into the OCaml runtime, for example allocating OCaml values or calling OCaml functions

impl<'a, T: 'static> OCaml<'a, DynBox<T>>

pub fn box_value(cr: &'a mut OCamlRuntime, v: T) -> Self

Build an OCaml value wrapping a Rust value

The returned value will be opaque to the OCaml side, though you can provide functions using it and expose them to OCaml.

It will be dropped if it stops being referenced by the GC.

Experimental

impl OCaml<'static, ()>

pub fn unit() -> Self

Returns a value that represent OCaml’s unit value.

impl<T> OCaml<'static, Option<T>>

pub fn none() -> Self

Returns a value that represent OCaml’s None value.

impl<'a> OCaml<'a, String>

pub fn as_bytes(&self) -> &'a [u8]

Returns an [u8] reference to the internal bytes of this value.

pub fn as_str(&self) -> &'a str

Returns a str reference to the internal bytes of this value.

Panics

Panics if the bytes do not form a valid utf8 string.

pub unsafe fn as_str_unchecked(&self) -> &'a str

Returns a str reference to the internal bytes of this value.

Safety

No checks are performed to ensure that the returned value is a valid utf8 string.

impl<'a> OCaml<'a, OCamlBytes>

pub fn as_bytes(&self) -> &'a [u8]

Returns an [u8] reference to the internal bytes of this value.

pub fn as_str(&self) -> &'a str

Returns a str reference to the internal bytes of this value.

Panics

Panics if the bytes do not form a valid utf8 string.

pub unsafe fn as_str_unchecked(&self) -> &'a str

Returns a str reference to the internal bytes of this value.

Safety

No checks are performed to ensure that the returned value is a valid utf8 string.

impl<'a> OCaml<'a, OCamlInt>

pub fn to_i64(&self) -> i64

Converts an OCaml int to an i64.

pub unsafe fn of_i64_unchecked(n: i64) -> OCaml<'static, OCamlInt>

Creates an OCaml int from an i64 without checking that it fits in an OCaml fixnum.

Safety

OCaml ints are represented as 63bits + 1bit tag, so when converting from an i64, a bit of precision is lost.

pub fn of_i64( n: i64 ) -> Result<OCaml<'static, OCamlInt>, OCamlFixnumConversionError>

pub fn of_i32(n: i32) -> OCaml<'static, OCamlInt>

Creates an OCaml int from an i32.

impl<'a> OCaml<'a, bool>

pub fn to_bool(&self) -> bool

Converts an OCaml boolean into a Rust boolean.

pub fn of_bool(b: bool) -> OCaml<'static, bool>

Creates an OCaml boolean from a Rust boolean.

impl<'a, A> OCaml<'a, Option<A>>

pub fn is_none(&self) -> bool

Returns true if this OCaml option value is an OCaml None.

pub fn is_some(&self) -> bool

Returns true if this OCaml option value is an OCaml Some.

pub fn to_option(&self) -> Option<OCaml<'a, A>>

Converts an OCaml Option<T> value into a Rust Option<OCaml<T>>.

impl<'a, A, Err> OCaml<'a, Result<A, Err>>

pub fn is_ok(&self) -> bool

Returns true if this OCaml result value is an OCaml Ok.

pub fn is_error(&self) -> bool

Returns true if this OCaml result value is an OCaml Error.

pub fn to_result(&self) -> Result<OCaml<'a, A>, OCaml<'a, Err>>

Converts an OCaml Result<T, E> value into a Rust Result<OCaml<T>, OCaml<E>>.

impl<'a, A> OCaml<'a, OCamlList<A>>

pub fn nil() -> Self

Returns an OCaml nil (empty list) value.

pub fn is_empty(&self) -> bool

Returns true if the value is OCaml’s nil (empty list).

pub fn hd(&self) -> Option<OCaml<'a, A>>

Returns the head of an OCaml list.

pub fn tl(&self) -> Option<OCaml<'a, OCamlList<A>>>

Returns the tail of an OCaml list.

pub fn uncons(&self) -> Option<(OCaml<'a, A>, Self)>

Returns a tuple of the head and tail of an OCaml list.

impl<'a, A, B> OCaml<'a, (A, B)>

pub fn to_tuple(&self) -> (OCaml<'a, A>, OCaml<'a, B>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

impl<'a, A, B, C> OCaml<'a, (A, B, C)>

pub fn to_tuple(&self) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

impl<'a, A, B, C, D> OCaml<'a, (A, B, C, D)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

impl<'a, A, B, C, D, E> OCaml<'a, (A, B, C, D, E)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>, OCaml<'a, E>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

pub fn tuple_5(&self) -> OCaml<'a, E>

impl<'a, A, B, C, D, E, F> OCaml<'a, (A, B, C, D, E, F)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>, OCaml<'a, E>, OCaml<'a, F>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

pub fn tuple_5(&self) -> OCaml<'a, E>

pub fn tuple_6(&self) -> OCaml<'a, F>

impl<'a, A, B, C, D, E, F, G> OCaml<'a, (A, B, C, D, E, F, G)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>, OCaml<'a, E>, OCaml<'a, F>, OCaml<'a, G>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

pub fn tuple_5(&self) -> OCaml<'a, E>

pub fn tuple_6(&self) -> OCaml<'a, F>

pub fn tuple_7(&self) -> OCaml<'a, G>

impl<'a, A, B, C, D, E, F, G, H> OCaml<'a, (A, B, C, D, E, F, G, H)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>, OCaml<'a, E>, OCaml<'a, F>, OCaml<'a, G>, OCaml<'a, H>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

pub fn tuple_5(&self) -> OCaml<'a, E>

pub fn tuple_6(&self) -> OCaml<'a, F>

pub fn tuple_7(&self) -> OCaml<'a, G>

pub fn tuple_8(&self) -> OCaml<'a, H>

impl<'a, A, B, C, D, E, F, G, H, I> OCaml<'a, (A, B, C, D, E, F, G, H, I)>

pub fn to_tuple( &self ) -> (OCaml<'a, A>, OCaml<'a, B>, OCaml<'a, C>, OCaml<'a, D>, OCaml<'a, E>, OCaml<'a, F>, OCaml<'a, G>, OCaml<'a, H>, OCaml<'a, I>)

pub fn fst(&self) -> OCaml<'a, A>

pub fn snd(&self) -> OCaml<'a, B>

pub fn tuple_3(&self) -> OCaml<'a, C>

pub fn tuple_4(&self) -> OCaml<'a, D>

pub fn tuple_5(&self) -> OCaml<'a, E>

pub fn tuple_6(&self) -> OCaml<'a, F>

pub fn tuple_7(&self) -> OCaml<'a, G>

pub fn tuple_8(&self) -> OCaml<'a, H>

pub fn tuple_9(&self) -> OCaml<'a, I>

impl<'a, A: BigarrayElt> OCaml<'a, Array1<A>>

pub fn len(&self) -> usize

Returns the number of items in self

pub fn is_empty(&self) -> bool

Returns true when self.len() == 0

pub fn as_slice(&self) -> &[A]

Get underlying data as Rust slice

impl<'a> OCaml<'a, OCamlException>

pub fn message(&self) -> Option<String>

If the exception has a single argument of type string, extracts and returns it. Examples of such exceptions are Failure of string (raised via the failwith OCaml function, or the caml_raise_with_string C function) or Invalid_argument of string.

Trait Implementations

impl<'a, A: BigarrayElt> Borrow<[A]> for OCaml<'a, Array1<A>>

fn borrow(&self) -> &[A]

Immutably borrows from an owned value.

impl<'a, A: 'static> Borrow<A> for OCaml<'a, DynBox<A>>

fn borrow(&self) -> &A

Immutably borrows from an owned value.

impl<'a, T> Clone for OCaml<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T> Deref for OCaml<'a, T>

type Target = OCamlCell<T>

The resulting type after dereferencing.

fn deref(&self) -> OCamlRef<'_, T>

Dereferences the value.

impl<'a, T> Copy for OCaml<'a, T>