fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-03-31 06:51:04 +00:00
Code Issues Projects Releases Wiki Activity

doc(runtime-c-api) Improve documentation of wasmer_instance_context_get.

Browse Source
This commit is contained in:
Ivan Enderlin 2020-01-20 14:36:11 +01:00
parent cd3a1064f9
commit 77ba77446d
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/runtime-c-api/src/instance.rs
View File

@ -171,7 +171,20 @@ pub unsafe extern "C" fn wasmer_instantiate(
wasmer_result_t::WASMER_OK wasmer_result_t::WASMER_OK
} }
/// Extracts the instance's context and returns it. /// Returns the instance context. Learn more by looking at the
/// `wasmer_instance_context_t` struct.
///
/// This function returns `null` if `instance` is a null pointer.
///
/// Example:
///
/// ```c
/// const wasmer_instance_context_get *context = wasmer_instance_context_get(instance);
/// my_data *data = (my_data *) wasmer_instance_context_data_get(context);
/// // Do something with `my_data`.
/// ```
///
/// It is often useful with `wasmer_instance_context_data_set()`.
#[allow(clippy::cast_ptr_alignment)] #[allow(clippy::cast_ptr_alignment)]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn wasmer_instance_context_get( pub unsafe extern "C" fn wasmer_instance_context_get(