Crate uniffi

Modules

• deps
• ffi
  Types that can cross the FFI boundary.
• metadata
  Pack UniFFI interface metadata into byte arrays

Macros

• assert_compatible_version
  Assert that the uniffi runtime version matches an expected value.
• build_foreign_language_testcases
  A macro to build testcases for a component’s generated bindings.
• custom_newtype
  Generate the FfiConverter and the UniffiCustomTypeConverter implementations for a Custom Type - ie, for a <T> which implements UniffiCustomTypeConverter via the newtype idiom.
• custom_type
  Generate the FfiConverter implementation for a Custom Type - ie, for a <T> which implements UniffiCustomTypeConverter.
• derive_ffi_traits
  Derive FFI traits
• ffi_converter_arc_forward
  Macro to implement FfiConverterArc<T> for a UniFfiTag using a different UniFfiTag
• ffi_converter_forward
  Macro to implement FfiConverter<T> for a UniFfiTag using a different UniFfiTag
• ffi_converter_rust_buffer_lift_and_lower
  Macro to implement lowering/lifting using a RustBuffer
• generate_and_include_scaffolding
  A helper macro to generate and include component scaffolding.
• include_scaffolding
  A helper macro to include generated component scaffolding.
• setup_scaffolding
  Top-level initialization macro
• use_udl_enum
• use_udl_error
• use_udl_object
• use_udl_record

Structs

• ForeignBytes
  Support for reading a slice of foreign-language-allocated bytes over the FFI.
• ForeignCallbackInternals
  Struct to hold a foreign callback.
• ForeignExecutor
  Schedule Rust calls using a foreign executor
• ForeignExecutorHandle
  Opaque handle for a foreign task executor.
• MetadataBuffer
• RustBuffer
  Support for passing an allocated-by-Rust buffer of bytes over the FFI.
• RustCallStatus
  Represents the success/error of a rust call
• RustFutureHandle
  Opaque handle for a Rust future that’s stored by the foreign language code
• UnexpectedUniFFICallbackError
  Used when internal/unexpected error happened when calling a foreign callback, for example when a unknown exception is raised

Enums

• CallbackResult
  Result of a foreign callback invocation
• ForeignExecutorCallbackResult
  Result code returned by ForeignExecutorCallback
• RustCallStatusCode
  Result of a FFI call to a Rust function
• RustFuturePoll
  Result code for rust_future_poll. This is passed to the continuation function.
• RustTaskCallbackCode
  Passed to a RustTaskCallback function when the executor invokes them.

Constants

• IDX_CALLBACK_FREE
  The method index used by the Drop trait to communicate to the foreign language side that Rust has finished with it, and it can be deleted from the handle map.

Traits

• ConvertError
• FfiConverter
  Generalized FFI conversions
• FfiConverterArc
  FfiConverter for Arc-types
• FfiDefault
• Lift
  Lift values passed by the foreign code over the FFI into Rust values
• LiftRef
  Lift references
• LiftReturn
  Return foreign values to Rust
• Lower
  Lower Rust values to pass them to the foreign code
• LowerReturn
  Return Rust values to the foreign code

Functions

• check_compatible_version
  Check whether the uniffi runtime version is compatible a given uniffi_bindgen version.
• check_remaining
  A helper function to ensure we don’t read past the end of a buffer.
• checksum_metadata
• foreign_executor_callback_set
  Set the global ForeignExecutorCallback. This is called by the foreign bindings, normally during initialization.
• rust_call
  Handle a scaffolding calls
• rust_future_cancel^⚠
  Cancel a Rust future
• rust_future_complete^⚠
  Complete a Rust future
• rust_future_free^⚠
  Free a Rust future, dropping the strong reference and releasing all references held by the future.
• rust_future_new
  Create a new RustFutureHandle
• rust_future_poll^⚠
  Poll a Rust future
• uniffi_rustbuffer_alloc
• uniffi_rustbuffer_free
• uniffi_rustbuffer_from_bytes
• uniffi_rustbuffer_reserve

Type Definitions

• ForeignCallback
  ForeignCallback is the Rust representation of a foreign language function. It is the basis for all callbacks interfaces. It is registered exactly once per callback interface, at library start up time. Calling this method is only done by generated objects which mirror callback interfaces objects in the foreign language.
• ForeignExecutorCallback
  Callback to schedule a Rust call with a ForeignExecutor. The bindings code registers exactly one of these with the Rust code.
• Result
  Result<T, Error>
• RustFutureContinuationCallback
  Foreign callback that’s passed to rust_future_poll
• RustTaskCallback
  Callback for a Rust task, this is what the foreign executor invokes

Attribute Macros

• constructor
  A dummy macro that does nothing.
• export

Derive Macros

• Enum
• Error
• Object
• Record