logos-messaging/libchat
1
0
Fork 0
mirror of https://github.com/logos-messaging/libchat.git synced 2026-02-10 17:03:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up FFI docs and imports

Browse Source
This commit is contained in:
Jazz Turner-Baggs 2026-02-06 13:10:22 -08:00
parent 06fe6bd2d3
commit ff15da63a1
No known key found for this signature in database
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
conversations/src/api.rs
View File

@ -1,6 +1,13 @@
use safer_ffi::prelude::*; // This is the FFI Interface to enable libchat to be used from other languages such as Nim and C.
// This interface makes heavy use of safer_ffi in order to safely move bytes across the FFI.
//
// The following table explains the safer_ffi types in use, and under what circumstances.
//
// - c_slice::Ref<'_, u8> : Borrowed, read-only byte slice for input parameters
// - c_slice::Mut<'_, u8> : Borrowed, mutable byte slice for in/out parameters
// - repr_c::Vec<u8> : Owned vector, used for return values (transfers ownership to caller)
// - repr_c::String : Owned string, used for return values (transfers ownership to caller)
// Must only contain negative values, values cannot be changed once set.
use safer_ffi::{ use safer_ffi::{
String, derive_ReprC, ffi_export, String, derive_ReprC, ffi_export,
prelude::{c_slice, repr_c}, prelude::{c_slice, repr_c},
@ -11,6 +18,8 @@ use crate::{
errors::ChatError, errors::ChatError,
types::ContentData, types::ContentData,
}; };
// Must only contain negative values or 0, values cannot be changed once set.
#[repr(i32)] #[repr(i32)]
pub enum ErrorCode { pub enum ErrorCode {
None = 0, None = 0,
@ -22,11 +31,14 @@ pub enum ErrorCode {
UnknownError = -6, UnknownError = -6,
} }
use crate::context::{Context, Introduction};
pub fn is_ok(error: i32) -> bool { pub fn is_ok(error: i32) -> bool {
error == ErrorCode::None as i32 error == ErrorCode::None as i32
} }
// ------------------------------------------
// Exported Functions
// ------------------------------------------
/// Opaque wrapper for Context /// Opaque wrapper for Context
#[derive_ReprC] #[derive_ReprC]
#[repr(opaque)] #[repr(opaque)]
@ -145,12 +157,12 @@ pub fn send_content(
} }
} }
/// Handles an incoming payload and writes content to caller-provided buffers /// Handles an incoming payload
/// ///
/// # Returns /// # Returns
/// Returns the number of bytes written to data_out on success (>= 0). /// Returns HandlePayloadResult
/// Returns negative error code on failure (see ErrorCode). /// This call does not always generate content. If data is zero bytes long then there
/// conversation_id_out_len is set to the number of bytes written to conversation_id_out. /// is no data, and the converation_id should be ignored.
#[ffi_export] #[ffi_export]
pub fn handle_payload( pub fn handle_payload(
ctx: &mut ContextHandle, ctx: &mut ContextHandle,
@ -162,6 +174,9 @@ pub fn handle_payload(
} }
} }
// ------------------------------------------
// Return Type Definitions
// ------------------------------------------
/// Result structure for create_intro_bundle /// Result structure for create_intro_bundle
/// error_code is 0 on success, negative on error (see ErrorCode) /// error_code is 0 on success, negative on error (see ErrorCode)
@ -172,9 +187,6 @@ pub struct CreateIntroResult {
pub intro_bytes: repr_c::Vec<u8>, pub intro_bytes: repr_c::Vec<u8>,
} }
// ============================================================================
// safer_ffi implementation
// ===============================================================================================================================
/// Free the result from create_intro_bundle /// Free the result from create_intro_bundle
#[ffi_export] #[ffi_export]
pub fn destroy_intro_result(result: CreateIntroResult) { pub fn destroy_intro_result(result: CreateIntroResult) {
@ -190,7 +202,7 @@ pub struct Payload {
pub data: repr_c::Vec<u8>, pub data: repr_c::Vec<u8>,
} }
/// Result structure for create_intro_bundle_safe /// Result structure for send_content
/// error_code is 0 on success, negative on error (see ErrorCode) /// error_code is 0 on success, negative on error (see ErrorCode)
#[derive_ReprC] #[derive_ReprC]
#[repr(C)] #[repr(C)]
@ -199,7 +211,6 @@ pub struct SendContentResult {
pub payloads: repr_c::Vec<Payload>, pub payloads: repr_c::Vec<Payload>,
} }
/// Free the result from create_intro_bundle_safe
/// Free the result from send_content /// Free the result from send_content
#[ffi_export] #[ffi_export]
pub fn destroy_send_content_result(result: SendContentResult) { pub fn destroy_send_content_result(result: SendContentResult) {
@ -223,7 +234,6 @@ pub fn destroy_handle_payload_result(result: HandlePayloadResult) {
drop(result); drop(result);
} }
/// Result structure for create_new_private_convo_safe
impl From<ContentData> for HandlePayloadResult { impl From<ContentData> for HandlePayloadResult {
fn from(value: ContentData) -> Self { fn from(value: ContentData) -> Self {
HandlePayloadResult { HandlePayloadResult {
@ -259,6 +269,7 @@ impl From<ChatError> for HandlePayloadResult {
} }
} }
/// Result structure for create_new_private_convo
/// error_code is 0 on success, negative on error (see ErrorCode) /// error_code is 0 on success, negative on error (see ErrorCode)
#[derive_ReprC] #[derive_ReprC]
#[repr(C)] #[repr(C)]
@ -268,7 +279,7 @@ pub struct NewConvoResult {
pub payloads: repr_c::Vec<Payload>, pub payloads: repr_c::Vec<Payload>,
} }
/// Free the result from create_new_private_convo_safe /// Free the result from create_new_private_convo
#[ffi_export] #[ffi_export]
pub fn destroy_convo_result(result: NewConvoResult) { pub fn destroy_convo_result(result: NewConvoResult) {
drop(result); drop(result);