Crate uniffi

Modules

• deps
  Reexport items from other uniffi creates
• ffi
  Reexport items from other uniffi creates Types that can cross the FFI boundary.
• metadata
  Reexport items from other uniffi creates Pack UniFFI interface metadata into byte arrays

Macros

• assert_compatible_version
  Reexport items from other uniffi creates 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
  Reexport items from other uniffi creates Derive FFI traits
• ffi_converter_arc_forward
  Reexport items from other uniffi creates Macro to implement FfiConverterArc<T> for a UniFfiTag using a different UniFfiTag
• ffi_converter_forward
  Reexport items from other uniffi creates Macro to implement FfiConverter<T> for a UniFfiTag using a different UniFfiTag
• ffi_converter_rust_buffer_lift_and_lower
  Reexport items from other uniffi creates 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
  Reexport items from other uniffi creates Support for reading a slice of foreign-language-allocated bytes over the FFI.
• ForeignCallbackInternals
  Reexport items from other uniffi creates Struct to hold a foreign callback.
• ForeignExecutor
  Reexport items from other uniffi creates Schedule Rust calls using a foreign executor
• ForeignExecutorHandle
  Reexport items from other uniffi creates Opaque handle for a foreign task executor.
• MetadataBuffer
  Reexport items from other uniffi creates
• RustBuffer
  Reexport items from other uniffi creates Support for passing an allocated-by-Rust buffer of bytes over the FFI.
• RustCallStatus
  Reexport items from other uniffi creates Represents the success/error of a rust call
• RustFutureHandle
  Reexport items from other uniffi creates Opaque handle for a Rust future that’s stored by the foreign language code
• UnexpectedUniFFICallbackError
  Reexport items from other uniffi creates Used when internal/unexpected error happened when calling a foreign callback, for example when a unknown exception is raised

Enums

• CallbackResult
  Reexport items from other uniffi creates Result of a foreign callback invocation
• ForeignExecutorCallbackResult
  Reexport items from other uniffi creates Result code returned by ForeignExecutorCallback
• RustCallStatusCode
  Reexport items from other uniffi creates Result of a FFI call to a Rust function
• RustFuturePoll
  Reexport items from other uniffi creates Result code for rust_future_poll. This is passed to the continuation function.
• RustTaskCallbackCode
  Reexport items from other uniffi creates Passed to a RustTaskCallback function when the executor invokes them.
• TargetLanguage
  Enumeration of all foreign language targets currently supported by this crate.

Constants

• IDX_CALLBACK_FREE
  Reexport items from other uniffi creates 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
  Reexport items from other uniffi creates
• FfiConverter
  Reexport items from other uniffi creates Generalized FFI conversions
• FfiConverterArc
  Reexport items from other uniffi creates FfiConverter for Arc-types
• FfiDefault
  Reexport items from other uniffi creates
• Lift
  Reexport items from other uniffi creates Lift values passed by the foreign code over the FFI into Rust values
• LiftRef
  Reexport items from other uniffi creates Lift references
• LiftReturn
  Reexport items from other uniffi creates Return foreign values to Rust
• Lower
  Reexport items from other uniffi creates Lower Rust values to pass them to the foreign code
• LowerReturn
  Reexport items from other uniffi creates Return Rust values to the foreign code

Functions

• check_compatible_version
  Reexport items from other uniffi creates Check whether the uniffi runtime version is compatible a given uniffi_bindgen version.
• check_remaining
  Reexport items from other uniffi creates A helper function to ensure we don’t read past the end of a buffer.
• checksum_metadata
  Reexport items from other uniffi creates
• foreign_executor_callback_set
  Reexport items from other uniffi creates Set the global ForeignExecutorCallback. This is called by the foreign bindings, normally during initialization.
• generate_bindings
• generate_component_scaffolding
• generate_component_scaffolding_for_crate
• generate_scaffolding
  Generate the rust “scaffolding” required to build a uniffi component.
• generate_scaffolding_for_crate
  Like generate_scaffolding, but uses the specified crate_name instead of locating and parsing Cargo.toml.
• print_repr
• rust_call
  Reexport items from other uniffi creates Handle a scaffolding calls
• rust_future_cancel^⚠
  Reexport items from other uniffi creates Cancel a Rust future
• rust_future_complete^⚠
  Reexport items from other uniffi creates Complete a Rust future
• rust_future_free^⚠
  Reexport items from other uniffi creates Free a Rust future, dropping the strong reference and releasing all references held by the future.
• rust_future_new
  Reexport items from other uniffi creates Create a new RustFutureHandle
• rust_future_poll^⚠
  Reexport items from other uniffi creates Poll a Rust future
• uniffi_bindgen_main
• uniffi_rustbuffer_alloc
  Reexport items from other uniffi creates
• uniffi_rustbuffer_free
  Reexport items from other uniffi creates
• uniffi_rustbuffer_from_bytes
  Reexport items from other uniffi creates
• uniffi_rustbuffer_reserve
  Reexport items from other uniffi creates

Type Aliases

• ForeignCallback
  Reexport items from other uniffi creates 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
  Reexport items from other uniffi creates Callback to schedule a Rust call with a ForeignExecutor. The bindings code registers exactly one of these with the Rust code.
• Result
  Reexport items from other uniffi creates Result<T, Error>
• RustFutureContinuationCallback
  Reexport items from other uniffi creates Foreign callback that’s passed to rust_future_poll
• RustTaskCallback
  Reexport items from other uniffi creates 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