Struct ocaml::value::Value

pub struct Value(pub Value);

Value wraps the native OCaml value type

Methods

impl Value

fn alloc(n: usize, tag: Tag) -> Value

Allocate a new value with the given size and tag

fn alloc_small(n: usize, tag: Tag) -> Value

Allocate a new small value with the given size and tag

fn new(v: Value) -> Value

Create a new Value from an existing OCaml value

fn value(&self) -> Value

Get the underlying OCaml value

fn tag(&self) -> Tag

Get the tag for the underlying OCaml value

fn ptr<T>(p: *const T) -> Value

Create a new opaque pointer Value

fn i32(i: i32) -> Value

Create an integer Value from i32

fn i64(i: i64) -> Value

Create an integer Value from i64

fn isize(i: isize) -> Value

Create a long Value from isize

fn usize(u: usize) -> Value

Create a value from usize

fn f64(d: f64) -> Value

Create a value from f64

fn is_block(&self) -> bool

Check if a Value is an integer or block, returning true if the underlying value is a block

fn is_long(&self) -> bool

Check if a Value is an integer or block, returning true if the underlying value is an integer

fn field(&self, i: Size) -> Value

Get index of underlying OCaml block value

fn store_field<V: ToValue>(&mut self, i: Size, val: V)

Set index of underlying OCaml block value

fn i32_val(&self) -> i32

Convert an OCaml integer to i32

fn i64_val(&self) -> i64

Convert an OCaml integer to i64

fn isize_val(&self) -> isize

Convert an OCaml integer to isize

fn usize_val(&self) -> usize

Convert an OCaml integer to usize

fn f64_val(&self) -> f64

Convert an OCaml float to f64

fn ptr_val<T>(&self) -> *const T

Get a pointer stored in an opaque value

fn call<A: ToValue>(&self, arg: A) -> Result<Value, Error>

Call a closure with a single argument

fn call2<A: ToValue, B: ToValue>(
    &self,
    arg1: A,
    arg2: B
) -> Result<Value, Error>

Call a closure with two arguments

fn call3<A: ToValue, B: ToValue, C: ToValue>(
    &self,
    arg1: A,
    arg2: B,
    arg3: C
) -> Result<Value, Error>

Call a closure with three arguments

fn call_n<A: AsRef<[Value]>>(&self, args: A) -> Result<Value, Error>

Call a closure with n arguments

fn modify<V: ToValue>(&mut self, v: V)

Modify an OCaml value in place

Trait Implementations

impl From<Tuple> for Value

fn from(t: Tuple) -> Value

Performs the conversion.

impl From<Array> for Value

fn from(t: Array) -> Value

Performs the conversion.

impl From<List> for Value

fn from(t: List) -> Value

Performs the conversion.

impl From<Str> for Value

fn from(t: Str) -> Value

Performs the conversion.

impl Debug for Value

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ToValue for Value

fn to_value(&self) -> Value

impl FromValue for Value

fn from_value(v: Value) -> Value