fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-06-14 09:21:20 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Ivan Enderlin
2020-01-16 12:28:42 +01:00
parent 9ae83981be
commit 798557367a
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,13 +44,26 @@ pub unsafe extern "C" fn wasmer_compile(
wasmer_result_t::WASMER_OK wasmer_result_t::WASMER_OK
} }
/// Returns true for valid wasm bytes and false for invalid bytes /// Validates a sequence of bytes hoping it represents a valid WebAssembly module.
///
/// The function returns true if the bytes are valid, false otherwise.
///
/// Example:
///
/// ```c
/// bool result = wasmer_validate(bytes, bytes_length);
///
/// if (false == result) {
/// // Do something…
/// }
/// ```
#[allow(clippy::cast_ptr_alignment)] #[allow(clippy::cast_ptr_alignment)]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn wasmer_validate(wasm_bytes: *const u8, wasm_bytes_len: u32) -> bool { pub unsafe extern "C" fn wasmer_validate(wasm_bytes: *const u8, wasm_bytes_len: u32) -> bool {
if wasm_bytes.is_null() { if wasm_bytes.is_null() {
return false; return false;
} }
let bytes: &[u8] = slice::from_raw_parts(wasm_bytes, wasm_bytes_len as usize); let bytes: &[u8] = slice::from_raw_parts(wasm_bytes, wasm_bytes_len as usize);
wasmer_runtime_core::validate(bytes) wasmer_runtime_core::validate(bytes)