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

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

Browse Source
This commit is contained in:
Ivan Enderlin
2020-02-10 11:16:48 +01:00
parent 59d35656a9
commit e5fa1b3c1b
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -157,7 +157,19 @@ pub extern "C" fn wasmer_memory_length(memory: *const wasmer_memory_t) -> u32 {
length length
} }
/// Gets the start pointer to the bytes within a Memory /// Gets a pointer to the beginning of the contiguous memory data
/// bytes.
///
/// The function returns `NULL` if `memory` is NULL.
///
/// Note that when the memory grows, it can be reallocated, and thus
/// the returned pointer can be invalidated.
///
/// Example:
///
/// ```c
/// uint8_t *memory_data = wasmer_memory_data(memory);
/// ```
#[allow(clippy::cast_ptr_alignment)] #[allow(clippy::cast_ptr_alignment)]
#[no_mangle] #[no_mangle]
pub extern "C" fn wasmer_memory_data(mem: *const wasmer_memory_t) -> *mut u8 { pub extern "C" fn wasmer_memory_data(mem: *const wasmer_memory_t) -> *mut u8 {