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

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

Browse Source
This commit is contained in:
Ivan Enderlin
2020-02-10 11:36:53 +01:00
parent 38ee947354
commit b57cd83504
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/runtime-c-api/src/memory.rs
View File

@ -209,7 +209,23 @@ pub extern "C" fn wasmer_memory_data_length(memory: *mut wasmer_memory_t) -> u32
length as u32 length as u32
} }
/// Frees memory for the given Memory /// Frees memory for the given `wasmer_memory_t`.
///
/// Check the `wasmer_memory_new()` function to get a complete
/// example.
///
/// If `memory` is a null pointer, this function does nothing.
///
/// Example:
///
/// ```c
/// // Get a memory.
/// wasmer_memory_t *memory = NULL;
/// wasmer_result_t result = wasmer_memory_new(&memory, memory_descriptor);
///
/// // Destroy the memory.
/// wasmer_memory_destroy(memory);
/// ```
#[allow(clippy::cast_ptr_alignment)] #[allow(clippy::cast_ptr_alignment)]
#[no_mangle] #[no_mangle]
pub extern "C" fn wasmer_memory_destroy(memory: *mut wasmer_memory_t) { pub extern "C" fn wasmer_memory_destroy(memory: *mut wasmer_memory_t) {