apple-cf 0.10.0

Safe Rust bindings for Apple's shared Core* frameworks (CoreFoundation, CoreMedia, CoreVideo, CoreGraphics, IOSurface, Dispatch).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! FFI string utilities — back-compat shim over `doom_fish_utils::ffi_string`.
//!
//! Re-exports the generic, framework-agnostic helpers and adds the thin
//! wrappers [`crate::utils::ffi_string::ffi_string_owned`] and
//! [`crate::utils::ffi_string::ffi_string_owned_or_empty`]. They bake in
//! `crate::ffi::acf_free_string` as the deallocator so existing call sites
//! that used the apple-cf-specific helpers compile unchanged.

pub use doom_fish_utils::ffi_string::{
    ffi_string_from_buffer, ffi_string_from_buffer_or_empty, DEFAULT_BUFFER_SIZE, SMALL_BUFFER_SIZE,
};

/// Retrieves a string from an FFI function that returns an owned C string
/// pointer allocated by Swift (typically via `strdup`), freeing it with
/// `acf_free_string`.
///
/// This is a thin convenience over
/// [`doom_fish_utils::ffi_string::ffi_string_owned`].
///
/// # Safety
/// The caller must ensure the returned pointer was allocated by the
/// `apple-cf` Swift bridge (so that `acf_free_string` correctly releases
/// it). See the underlying helper for full safety contract.
pub unsafe fn ffi_string_owned<F>(ffi_call: F) -> Option<String>
where
    F: FnOnce() -> *mut i8,
{
    unsafe {
        doom_fish_utils::ffi_string::ffi_string_owned(ffi_call, |ptr| {
            crate::ffi::acf_free_string(ptr);
        })
    }
}

/// Same as [`crate::utils::ffi_string::ffi_string_owned`] but returns an empty
/// string on failure.
///
/// # Safety
/// Same requirements as [`crate::utils::ffi_string::ffi_string_owned`].
pub unsafe fn ffi_string_owned_or_empty<F>(ffi_call: F) -> String
where
    F: FnOnce() -> *mut i8,
{
    unsafe { ffi_string_owned(ffi_call) }.unwrap_or_default()
}