Trait FreeForeign

pub trait FreeForeign {
    type Foreign;

    // Required method
    unsafe fn free_foreign(p: *mut Self::Foreign);
}

A type for which there is a canonical representation as a C datum.

Required Associated Types

type Foreign

The representation of Self as a C datum. Typically a struct, though there are exceptions for example c_char for strings, since C strings are of char * type).

Required Methods

unsafe fn free_foreign(p: *mut Self::Foreign)

Free the C datum pointed to by p.

Safety

p must be NULL or point to valid data.

let foreign = "Hello, world!".clone_to_foreign();
unsafe {
    String::free_foreign(foreign.into_inner());
}

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl FreeForeign for bool

type Foreign = bool

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for f32

type Foreign = f32

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for f64

type Foreign = f64

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for i8

type Foreign = i8

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for i16

type Foreign = i16

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for i32

type Foreign = i32

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for i64

type Foreign = i64

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for isize

type Foreign = isize

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for str

type Foreign = i8

unsafe fn free_foreign(ptr: *mut c_char)

impl FreeForeign for u8

type Foreign = u8

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for u16

type Foreign = u16

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for u32

type Foreign = u32

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for u64

type Foreign = u64

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for usize

type Foreign = usize

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl FreeForeign for CString

type Foreign = i8

unsafe fn free_foreign(ptr: *mut c_char)

impl FreeForeign for String

type Foreign = i8

unsafe fn free_foreign(ptr: *mut c_char)

impl FreeForeign for CStr

type Foreign = i8

unsafe fn free_foreign(ptr: *mut c_char)

impl<'a, B> FreeForeign for Cow<'a, B>

where B: 'a + ToOwned + ?Sized + FreeForeign,

type Foreign = <B as FreeForeign>::Foreign

unsafe fn free_foreign(ptr: *mut B::Foreign)

impl<T> FreeForeign for Option<T>

where T: FreeForeign,

type Foreign = <T as FreeForeign>::Foreign

unsafe fn free_foreign(x: *mut Self::Foreign)

impl<T> FreeForeign for [T]

where T: FixedAlloc,

type Foreign = <T as FreeForeign>::Foreign

unsafe fn free_foreign(ptr: *mut Self::Foreign)

impl<T> FreeForeign for Box<T>

where T: FreeForeign,

type Foreign = <T as FreeForeign>::Foreign

unsafe fn free_foreign(x: *mut Self::Foreign)

impl<T> FreeForeign for Vec<T>

where [T]: FreeForeign,

type Foreign = <[T] as FreeForeign>::Foreign

unsafe fn free_foreign(x: *mut Self::Foreign)

impl<T, const N: usize> FreeForeign for [T; N]

where T: FixedAlloc,

type Foreign = <T as FreeForeign>::Foreign

unsafe fn free_foreign(ptr: *mut Self::Foreign)

Implementors