Module uniffi::ffi::foreignfuture

This module defines a Rust Future that wraps an async foreign function call.

The general idea is to create a [oneshot::Channel], hand the sender to the foreign side, and await the receiver side on the Rust side.

The foreign side should:

• Input a ForeignFutureCallback and a u64 handle in their scaffolding function. This is the sender, converted to a raw pointer, and an extern “C” function that sends the result.
• Return a ForeignFuture, which represents the foreign task object corresponding to the async function.
• Call the ForeignFutureCallback when the async function completes with:
  • The u64 handle initially passed in
  • The ForeignFutureResult for the call
• Wait for the [ForeignFutureHandle::free] function to be called to free the task object. If this is called before the task completes, then the task will be cancelled.

Structs

• 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

Functions

• foreign_async_call
• foreign_future_complete

Type Aliases

• 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