From 4b6725b51f472f620f6202f8e100999cc2511186 Mon Sep 17 00:00:00 2001 From: Jackson Coxson Date: Mon, 21 Jul 2025 08:18:31 -0600 Subject: [PATCH] Clarify AdapterStream FFI docs --- ffi/src/adapter.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ffi/src/adapter.rs b/ffi/src/adapter.rs index 8e6edb8..f960cc1 100644 --- a/ffi/src/adapter.rs +++ b/ffi/src/adapter.rs @@ -91,7 +91,7 @@ pub unsafe extern "C" fn adapter_pcap( } } -/// Closes the adapter connection +/// Closes the adapter stream connection /// /// # Arguments /// * [`handle`] - The adapter stream handle @@ -119,10 +119,10 @@ pub unsafe extern "C" fn adapter_close(handle: *mut AdapterStreamHandle) -> *mut } } -/// Sends data through the adapter +/// Sends data through the adapter stream /// /// # Arguments -/// * [`handle`] - The adapter handle +/// * [`handle`] - The adapter stream handle /// * [`data`] - The data to send /// * [`length`] - The length of the data /// @@ -156,10 +156,10 @@ pub unsafe extern "C" fn adapter_send( } } -/// Receives data from the adapter +/// Receives data from the adapter stream /// /// # Arguments -/// * [`handle`] - The adapter handle +/// * [`handle`] - The adapter stream handle /// * [`data`] - Pointer to a buffer where the received data will be stored /// * [`length`] - Pointer to store the actual length of received data /// * [`max_length`] - Maximum number of bytes that can be stored in `data`