Enum uniffi_bindgen::interface::ffi::FfiType

pub enum FfiType {
    UInt8,
    Int8,
    UInt16,
    Int16,
    UInt32,
    Int32,
    UInt64,
    Int64,
    Float32,
    Float64,
    RustArcPtr(String),
    RustBuffer(Option<String>),
    ForeignBytes,
    Callback(String),
    Struct(String),
    Handle,
    RustCallStatus,
    Reference(Box<FfiType>),
    VoidPointer,
}

Variants

UInt8

Int8

UInt16

Int16

UInt32

Int32

UInt64

Int64

Float32

Float64

RustArcPtr(String)

A *const c_void pointer to a rust-owned Arc<T>. If you’ve got one of these, you must call the appropriate rust function to free it. The templates will generate a unique free function for each T. The inner string references the name of the T type.

RustBuffer(Option<String>)

A byte buffer allocated by rust, and owned by whoever currently holds it. If you’ve got one of these, you must either call the appropriate rust function to free it or pass it to someone that will. If the inner option is Some, it is the name of the external type. The bindings may need to use this name to import the correct RustBuffer for that type.

ForeignBytes

A borrowed reference to some raw bytes owned by foreign language code. The provider of this reference must keep it alive for the duration of the receiving call.

Callback(String)

Pointer to a callback function. The inner value which matches one of the callback definitions in crate::ComponentInterface::ffi_definitions.

Struct(String)

Pointer to a FFI struct (e.g. a VTable). The inner value matches one of the struct definitions in crate::ComponentInterface::ffi_definitions.

Handle

Opaque 64-bit handle

These are used to pass objects across the FFI.

RustCallStatus

Reference(Box<FfiType>)

Pointer to an FfiType.

VoidPointer

Opaque pointer

Implementations

impl FfiType

pub fn reference(self) -> FfiType

pub fn return_type_name(return_type: Option<&FfiType>) -> String

Unique name for an FFI return type

Trait Implementations

impl Clone for FfiType

fn clone(&self) -> FfiType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FfiType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&&Type> for FfiType

fn from(ty: &&Type) -> Self

Converts to this type from the input type.

impl From<&Type> for FfiType

When passing data across the FFI, each Type value will be lowered into a corresponding FfiType value. This conversion tells you which one.

Note that the conversion is one-way - given an FfiType, it is not in general possible to tell what the corresponding Type is that it’s being used to represent.

fn from(t: &Type) -> FfiType

Converts to this type from the input type.

impl From<Type> for FfiType

fn from(ty: Type) -> Self

Converts to this type from the input type.

impl Hash for FfiType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FfiType

fn cmp(&self, other: &FfiType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FfiType

fn eq(&self, other: &FfiType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FfiType

fn partial_cmp(&self, other: &FfiType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for FfiType

impl StructuralPartialEq for FfiType