Struct uniffi_bindgen::interface::ffi::FfiFunction

pub struct FfiFunction {
    pub(super) name: String,
    pub(super) is_async: bool,
    pub(super) arguments: Vec<FfiArgument>,
    pub(super) return_type: Option<FfiType>,
    pub(super) has_rust_call_status_arg: bool,
    pub(super) is_object_free_function: bool,
}

Represents an “extern C”-style function that will be part of the FFI.

These can’t be declared explicitly in the UDL, but rather, are derived automatically from the high-level interface. Each callable thing in the component API will have a corresponding FfiFunction through which it can be invoked, and UniFFI also provides some built-in FfiFunction helpers for use in the foreign language bindings.

Fields

name: String

is_async: bool

arguments: Vec<FfiArgument>

return_type: Option<FfiType>

has_rust_call_status_arg: bool

is_object_free_function: bool

Used by C# generator to differentiate the free function and call it with void* instead of C# SafeHandle type. See https://github.com/mozilla/uniffi-rs/pull/1488.

Implementations

impl FfiFunction

pub fn callback_init( module_path: &str, trait_name: &str, vtable_name: String ) -> Self

pub fn name(&self) -> &str

pub fn is_async(&self) -> bool

pub fn arguments(&self) -> Vec<&FfiArgument>

pub fn return_type(&self) -> Option<&FfiType>

pub fn has_rust_call_status_arg(&self) -> bool

pub fn is_object_free_function(&self) -> bool

pub fn init( &mut self, return_type: Option<FfiType>, args: impl IntoIterator<Item = FfiArgument> )

Trait Implementations

impl Clone for FfiFunction

fn clone(&self) -> FfiFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FfiFunction

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

Formats the value using the given formatter.

impl Default for FfiFunction

fn default() -> Self

Returns the “default value” for a type.

impl From<FfiFunction> for FfiDefinition

fn from(value: FfiFunction) -> FfiDefinition

Converts to this type from the input type.