Struct ocaml_interop::OCaml

#[repr(transparent)]pub struct OCaml<'a, T: 'a> { /* fields omitted */ }

Representation of OCaml values inside ocaml_frame blocks.

Should not be instantiated directly, and will usually be the result of ocaml_alloc! and ocaml_call! expressions, or the input arguments of functions defined inside ocaml_export! blocks.

Implementations

impl<'a, T> OCaml<'a, 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 keep<'gc>(self, gc: &GCFrame<'gc>) -> OCamlRef<'gc, T>

Returns a tracked reference to this value.

This method must be used with values that will be referenced after calls into the OCaml runtime have been made.

impl OCaml<'static, ()>

pub fn unit() -> OCaml<'static, ()>

Returns a value that represent OCaml's unit value.

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

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

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

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

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

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

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

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

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

pub fn as_i64(&self) -> i64

Converts an OCaml int to an i64.

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

Creates an OCaml int from an i64.

Safety

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

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

Creates an OCaml int from an i32.

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

pub fn as_bool(self) -> bool

Converts an OCaml boolean into a Rust boolean.

pub fn of_bool(b: bool) -> Self

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, B> OCaml<'a, (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 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 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> 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 tl(&self) -> Option<OCaml<'a, A>>

Returns the tail of an OCaml list.

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

Returns the head 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.

Trait Implementations

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

fn clone(&self) -> OCaml<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

impl<'a, T, U> IntoRust<U> for OCaml<'a, T> where
    U: FromOCaml<T>, 

fn into_rust(self) -> U

Convert into a Rust value.