ferment-interfaces 0.1.4

Traits for FFI conversions and some helper methods
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
46
47
48
49
50
51
52

pub mod types {
    use crate::{boxed, FFIConversion, OpaqueContext, OpaqueContextMut};

    #[allow(non_camel_case_types)]
    pub type OpaqueContext_FFI = OpaqueContext;
    #[allow(non_camel_case_types)]
    pub type OpaqueContextMut_FFI = OpaqueContextMut;

    impl FFIConversion<OpaqueContext_FFI> for OpaqueContext {
        unsafe fn ffi_from_const(ffi: *const Self) -> OpaqueContext_FFI {
            *ffi
        }

        unsafe fn ffi_to_const(obj: OpaqueContext_FFI) -> *const Self {
            obj as *const _
        }

        unsafe fn ffi_from(ffi: *mut Self) -> OpaqueContext_FFI {
            *ffi
        }

        unsafe fn ffi_to(obj: OpaqueContext_FFI) -> *mut Self {
            // Converting a const pointer to a mut pointer and then writing to it can lead to undefined
            // behavior if the original memory location wasn't meant to be mutable
            obj as *mut _
        }

        unsafe fn destroy(_ffi: *mut Self) {
            // No destroy no ownership here
        }
    }

    impl FFIConversion<OpaqueContextMut_FFI> for OpaqueContextMut {
        unsafe fn ffi_from_const(ffi: *const Self) -> OpaqueContextMut_FFI {
            *ffi
        }

        unsafe fn ffi_to_const(obj: OpaqueContextMut_FFI) -> *const Self {
            obj as *const _
        }

        unsafe fn ffi_from(ffi: *mut Self) -> OpaqueContextMut_FFI {
            *ffi
        }

        unsafe fn ffi_to(obj: OpaqueContextMut_FFI) -> *mut Self {
            // Converting a const pointer to a mut pointer and then writing to it can lead to undefined
            // behavior if the original memory location wasn't meant to be mutable
            boxed(obj)
        }
    }
}