The vector type, declared in the C API with the WASM_DECLARE_VEC macro. Vectors always get ownership of their data.
type data_type = V.data_typeThe vector's data type
val data_type : data_type Ctypes.typThe vector's Ctypes data type declaration
type t = DeclareVec(V).tThe C unique (abstract) base type for the structure. the structure type is therefore t structure.
val t : t Ctypes.structure Ctypes.typThe Ctypes definition of the C structure.
val fsize : (Unsigned.size_t, t Ctypes.structure) Ctypes.fieldThe raw size field of the structure
val fdata : (data_type Ctypes.ptr, t Ctypes.structure) Ctypes.fieldThe raw data field of the structure
This structure maintains an ownership status. See also WasmerBindings.OwnableObject.
include module type of struct include OwnableObject(DeclareVec(V).{O}5) endOwnable objects are the basic structure that maintains an ownership state on C objects.
type s = OwnableObject(DeclareVec(V).{O}5).sThe owning structure type.
val make_new : unit -> sMake a new owning structure from a new pointer.
val make_from_raise : DeclareVec(V).{O}5.t Ctypes.ptr -> object_state -> sMake a new owning structure from a pointer. See also WasmerBindings.OwnableObject.make_from_unsafe.
val make_from_unsafe : DeclareVec(V).{O}5.t Ctypes.ptr -> object_state -> sMake a new owning structure from a pointer. Does not raise an exception if NULL is given. See also WasmerBindings.OwnableObject.make_from_raise.
val make_from_raise_data :
DeclareVec(V).{O}5.t Ctypes.ptr ->
object_state ->
DeclareVec(V).{O}5.d ->
sMake a new owning structure from a pointer, with an additional data. See also WasmerBindings.OwnableObject.make_from_unsafe_data.
val make_from_unsafe_data :
DeclareVec(V).{O}5.t Ctypes.ptr ->
object_state ->
DeclareVec(V).{O}5.d ->
sMake a new owning structure from a pointer, with an additional data. Does not raise an exception if NULL is given. See also WasmerBindings.OwnableObject.make_from_raise_data.
val get_state : s -> object_stateReturns the current ownership state.
val lose_ownership : s -> unitSets the current ownership state to WasmerBindings.object_state.State_PassedAway. Ignores the current ownership.
val grab_ownership : s -> DeclareVec(V).{O}5.t Ctypes.ptrgrab_ownership self gives the ownership of the pointed object to the caller code. It is equivalent to let p = get_ptr self in lose_ownership self; p, but with additional checks for the current ownership.
val gain_ownership_back : s -> DeclareVec(V).{O}5.t Ctypes.ptrDeletes the object if required, then sets the ownership to WasmerBindings.object_state.State_Owned and returns the pointer. This is only to be used in own-out function arguments in the C API or equivalent.
val is_null : s -> boolReturns Ctypes.is_null on the underlying pointer, ignoring the current ownership state.
val get_ptr : s -> DeclareVec(V).{O}5.t Ctypes.ptrReturns the underlying pointer, requiring a sufficient ownership state.
val get_ptr_const : s -> DeclareVec(V).{O}5.t Ctypes.ptrReturns the underlying pointer, requiring a sufficient ownership state.
val get_ptr_givenaway : s -> DeclareVec(V).{O}5.t Ctypes.ptrInherently unsafe function that returns a given-away pointer.
val delete : s -> unitFrees the underlying pointer. A side effect is to mark the object as given away.
val make_empty : unit -> sMakes a new vector, calling the wasm_*vec*_new C API function.
val make_empty_null : unit -> sMakes a new vector, initializing the data field to NULL.
val make_uninit : int -> sMakes a new uninitialized vector.
Duplicates the current vector. No guarantee is made on the deep-ness of the copy.
val of_array : V.owning_struct array -> sMakes a vector from an array, taking ownership of the elements.
val of_list : V.owning_struct list -> sMakes a vector from a list, taking ownership of the elements.
val get_size : s -> intGets the size field of the vector.
val get_element : s -> int -> V.owning_structget_element vec i gets the ith element of vec with the correct WasmerBindings.object_state.Dependent ownership state.
val get_element_unsafe : s -> int -> V.owning_structval get_element_const : s -> int -> V.owning_structget_element vec i gets the ith element of vec with the correct WasmerBindings.object_state.Dependent ownership state.
val get_element_const_unsafe : s -> int -> V.owning_structval set_element : s -> int -> V.owning_struct -> unitval set_element_unsafe : s -> int -> V.owning_struct -> unit