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
• 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.
• ForeignFuture
  Perform a call to a foreign async method C struct that represents the foreign future.
• ForeignFutureResult
  C struct that represents the result of a foreign future
• Handle
  Object handle
• MetadataBuffer
• RustBuffer
  Support for passing an allocated-by-Rust buffer of bytes over the FFI.
• RustCallStatus
  Represents the success/error of a rust call
• UnexpectedUniFFICallbackError
  Used when internal/unexpected error happened when calling a foreign callback, for example when a unknown exception is raised

Enums

• RustCallStatusCode
  Result of a FFI call to a Rust function
• RustFuturePoll
  Result code for rust_future_poll. This is passed to the continuation function.

Traits

• ConvertError
• FfiConverter
  Generalized FFI conversions
• FfiConverterArc
  FfiConverter for Arc-types
• FfiDefault
• HandleAlloc
  Manage handles for Arc<Self> instances
• 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_async_call
• foreign_future_complete
• 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 Handle for a Rust future
• rust_future_poll^⚠
  Poll a Rust future
• uniffi_rustbuffer_alloc
  This helper allocates a new byte buffer owned by the Rust code, and returns it to the foreign-language code as a RustBuffer struct. Callers must eventually free the resulting buffer, either by explicitly calling uniffi_rustbuffer_free defined below, or by passing ownership of the buffer back into Rust code.
• uniffi_rustbuffer_free
  Free a byte buffer that had previously been passed to the foreign language code.
• uniffi_rustbuffer_from_bytes
  This helper copies bytes owned by the foreign-language code into a new byte buffer owned by the Rust code, and returns it as a RustBuffer struct. Callers must eventually free the resulting buffer, either by explicitly calling the destructor defined below, or by passing ownership of the buffer back into Rust code.
• uniffi_rustbuffer_reserve
  Reserve additional capacity in a byte buffer that had previously been passed to the foreign language code.

Type Definitions

• ForeignFutureCallback
  Callback that’s passed to a foreign async functions.
• ForeignFutureCallbackData
  Handle for a callback data associated with a foreign future.
• ForeignFutureHandle
  Handle for a foreign future
• Result
  Result<T, Error>
• RustFutureContinuationCallback
  Foreign callback that’s passed to rust_future_poll

Attribute Macros

• constructor
  An attribute for constructors.
• export
• method
  An attribute for methods.

Derive Macros

• Enum
• Error
• Object
• Record