package wasmer

You can search for identifiers within the package.

in-package search v0.2.0

OCaml bindings for Wasmer

Install

Dune Dependency

github.com Readme Edit opam file Versions (1)

Authors

R

rajdakin

Maintainers

E

engineering@wasmer.io

Sources

v1.2.1+dunefix.tar.gz

md5=be37208390097ed6b7c7d9ede3c1a2a7

sha512=2422c3b32ae053a9f39336b1c9829ec9a508dd7d303e9a68853287ab7dea90b7cbc57f54a04b20a9fb6217527e1c89e8f806349407db5f8679d90fdf7dd3038e

doc/wasmer/Wasmer/Externtype/index.html

Module `Wasmer.Externtype`Source

include module type of struct include DeclareType(Externtype_T) end

include module type of struct include DeclareOwn(Externtype_T) end

Sourceval name : string

The C name of the structure without the _t suffix.

Sourcetype t = DeclareOwn(Externtype_T).t

The C unique (abstract) base type for the structure. the structure type is therefore t structure.

Sourceval t : t Ctypes.structure Ctypes.typ

The Ctypes definition of the C structure.

This structure maintains an ownership status. See also WasmerBindings.OwnableObject.

include module type of struct include OwnableObject(O) end

Sourcetype s = DeclareType(Externtype_T).s

The owning structure type.

Sourceval make_new : unit -> s

Make a new owning structure from a new pointer.

Source

val make_from_raise : 
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr ->
  object_state ->
  s

Make a new owning structure from a pointer. See also WasmerBindings.OwnableObject.make_from_unsafe.

raises Returned_null
If the pointer is NULL

Source

val make_from_unsafe : 
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr ->
  object_state ->
  s

Make a new owning structure from a pointer. Does not raise an exception if NULL is given. See also WasmerBindings.OwnableObject.make_from_raise.

Source

val make_from_raise_data : 
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr ->
  object_state ->
  Externtype_T.d ->
  s

Make a new owning structure from a pointer, with an additional data. See also WasmerBindings.OwnableObject.make_from_unsafe_data.

raises Returned_null
If the pointer is NULL

Source

val make_from_unsafe_data : 
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr ->
  object_state ->
  Externtype_T.d ->
  s

Make 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.

Sourceval get_state : s -> object_state

Returns the current ownership state.

Sourceval lose_ownership : s -> unit

Sets the current ownership state to WasmerBindings.object_state.State_PassedAway. Ignores the current ownership.

Source

val grab_ownership : 
  s ->
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr

grab_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.

returns
The pointer

Source

val gain_ownership_back : 
  s ->
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr

Deletes 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.

returns
A deleted or given-away pointer.

raises Invalid_access
If the current state is WasmerBindings.object_state.State_Dependent

Sourceval is_null : s -> bool

Returns Ctypes.is_null on the underlying pointer, ignoring the current ownership state.

Sourceval get_ptr : s -> DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr

Returns the underlying pointer, requiring a sufficient ownership state.

raises Invalid_access
If the current state is lower than WasmerBindings.object_state.State_RW

Sourceval get_ptr_const : s -> DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr

Returns the underlying pointer, requiring a sufficient ownership state.

raises Invalid_access
If the current state is lower than WasmerBindings.object_state.State_Const

Source

val get_ptr_givenaway : 
  s ->
  DeclareOwn(Externtype_T).t Ctypes.structure Ctypes.ptr

Inherently unsafe function that returns a given-away pointer.

raises Invalid_access
If the current state is not WasmerBindings.object_state.State_PassedAway

Sourceval delete : s -> unit

Frees the underlying pointer. A side effect is to mark the object as given away.

Sourcemodule V = DeclareType(Externtype_T).V

Sourcemodule Vec = DeclareType(Externtype_T).Vec

Sourceval duplicate : s -> s

Sourceval duplicate_unsafe : s -> s

Sourceval kind : s -> Externkind.ocaml

Sourceval of_functype : Functype.s -> s

Sourceval of_globaltype : Globaltype.s -> s

Sourceval of_tabletype : Tabletype.s -> s

Sourceval of_memorytype : Memorytype.s -> s

Sourceval to_functype : s -> Functype.s

Sourceval to_globaltype : s -> Globaltype.s

Sourceval to_tabletype : s -> Tabletype.s

Sourceval to_memorytype : s -> Memorytype.s

Sourceval of_functype_const : Functype.s -> s

Sourceval of_globaltype_const : Globaltype.s -> s

Sourceval of_tabletype_const : Tabletype.s -> s

Sourceval of_memorytype_const : Memorytype.s -> s

Sourceval to_functype_const : s -> Functype.s

Sourceval to_globaltype_const : s -> Globaltype.s

Sourceval to_tabletype_const : s -> Tabletype.s

Sourceval to_memorytype_const : s -> Memorytype.s

package wasmer

Install

Dune Dependency

Authors

Maintainers

Sources

doc/wasmer/Wasmer/Externtype/index.html

Module Wasmer.ExterntypeSource

Module `Wasmer.Externtype`Source