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

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

Browse Source
This commit is contained in:
Ivan Enderlin 2020-02-10 11:04:09 +01:00
parent ed77c9c64f
commit 78056df6cc
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -120,7 +120,17 @@ pub extern "C" fn wasmer_memory_grow(memory: *mut wasmer_memory_t, delta: u32) -
} }
} }
/// Returns the current length in pages of the given memory /// Reads the current length (in pages) of the given memory.
///
/// The function returns zero if `memory` is null.
///
/// Example:
///
/// ```c
/// uint32_t memory_length = wasmer_memory_length(memory);
///
/// printf("Memory pages length: %d\n", memory_length);
/// ```
#[allow(clippy::cast_ptr_alignment)] #[allow(clippy::cast_ptr_alignment)]
#[no_mangle] #[no_mangle]
pub extern "C" fn wasmer_memory_length(memory: *const wasmer_memory_t) -> u32 { pub extern "C" fn wasmer_memory_length(memory: *const wasmer_memory_t) -> u32 {