package wasmer

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package wasmer

wasmer
- README
- Library wasmer
  - Wasmer
    
    ObjectType
    
    StructType
    
    VectorType
    
    OwnableObject
    
    DeclareOwn
    
    DeclareVec
    
    DeclareType
    
    V
    
    Vec
    
    DeclareRefBase
    
    Ref_T
    
    Ref
    
    O
    
    DeclareRef
    
    Wasi_
    
    Env_O_
    
    Env_
    
    Byte
    
    V
    
    Vec
    
    Name
    
    Message
    
    Config_T
    
    Config
    
    Engine_T
    
    Engine
    
    Store_T
    
    Store
    
    Mutability
    
    Limits
    
    Valkind
    
    Valtype_T
    
    Valtype
    
    V
    
    Vec
    
    Functype_T
    
    Functype
    
    V
    
    Vec
    
    Globaltype_T
    
    Globaltype
    
    V
    
    Vec
    
    Tabletype_T
    
    Tabletype
    
    V
    
    Vec
    
    Memorytype_T
    
    Memorytype
    
    V
    
    Vec
    
    Externkind
    
    Externtype_T
    
    Externtype
    
    V
    
    Vec
    
    Importtype_T
    
    Importtype
    
    V
    
    Vec
    
    Exporttype_T
    
    Exporttype
    
    V
    
    Vec
    
    Val
    
    Anon0
    
    O
    
    V
    
    Vec
    
    DeclareShareableRef
    
    S
    
    Shared
    
    Frame_T
    
    Frame
    
    V
    
    Vec
    
    Trap_T
    
    Trap
    
    Foreign_T
    
    Foreign
    
    Module_T
    
    Module
    
    Func_T
    
    Func
    
    V
    
    Vec
    
    Global_T
    
    Global
    
    V
    
    Vec
    
    Table_T
    
    Table
    
    V
    
    Vec
    
    Memory_T
    
    Memory
    
    V
    
    Vec
    
    Extern_T
    
    Extern
    
    V
    
    Vec
    
    Instance_T
    
    Instance
    
    Wasi
    
    Config_T
    
    Config
    
    O
    
    NamedExtern_T
    
    NamedExtern
    
    O
    
    V
    
    Vec
    
    O
    
    Env_O_
    
    Env_
    
    Env_T
    
    Env
    
    Util
- Sources
  - wasmer
    
    wasmer.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Wasmer.DeclareOwn`Source

The base WASM objects, declared in wasm.h as WASM_DECLARE_OWN.

Parameters

module T : StructType

Signature

Sourceval name : string

The C name of the structure without the _t suffix.

Sourcetype 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

The owning structure type.

Sourceval make_new : unit -> s

Make a new owning structure from a new pointer.

Sourceval make_from_raise : 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

Sourceval make_from_unsafe : 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 : 
  t Ctypes.structure Ctypes.ptr ->
  object_state ->
  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 : 
  t Ctypes.structure Ctypes.ptr ->
  object_state ->
  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.

Sourceval grab_ownership : s -> 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

Sourceval gain_ownership_back : s -> 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 -> 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 -> 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

Sourceval get_ptr_givenaway : s -> 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.

package wasmer

Module Wasmer.DeclareOwnSource

Parameters

Signature

Module `Wasmer.DeclareOwn`Source