Expand description
§Ark low-level FFI API
This is the low-level mostly unsafe layer that defines the ABI between the Ark host and Wasm modules.
It is not intended to be used directly, instead users should use the safe and easier to use ark-api
crate in modules.
Also see 🗺️ APIs in Ark Developer Guide
Modules§
- applet_
v0 - applet_
v1 - applet_
v2 - applet_
v3 - applet_
v4 - applet_
v5 - behavior_
controller_ v0 - behavior_
v0 - core_v0
- core_v1
- core_v2
- core_v3
- core_v4
- entrypoints
- example_
automatic - example_
manual - file_
ux_ v0 - http_
request_ v1 - ml_v1
- ml_v2
- ml_v3
- ml_v4
- module_
run_ v0 - profiler_
v0 - render_
v0 - render_
v1 - resource_
v0 - resource_
v1 - storage_
v1 - telemetry_
v0 - time_v1
- user_v1
- world_
v0 - world_
v1 - world_
v2 - world_
v3 - world_
v4
Structs§
- Align16
I128 - A thin wrapper around i128 that ensures 16-byte alignment.
- Align16
U128 - A thin wrapper around u128 that ensures 16-byte alignment.
- ApiId
- API identifier containing unique id and name
- Invalid
PodBool - Invalid value stored in
PodBool
when trying to interpret it as abool
- PodBool
- A version of
bool
that has the same layout asbool
but isbytemuck::Pod
. - Semver
- Transparent
Pad - This type adds some
const PAD
number of “explicit” or “manual” padding bytes to the end of a struct.
Enums§
- Error
Code - Error return codes for API functions.
Type Aliases§
- FFIResult
- A result from an FFI function.