Struct ForeignExecutor

pub struct ForeignExecutor { /* private fields */ }

Reexport items from other uniffi creates Schedule Rust calls using a foreign executor

Implementations

impl ForeignExecutor

pub fn new(executor: ForeignExecutorHandle) -> ForeignExecutor

pub fn schedule<F>(&self, delay: u32, task: F)

where F: FnOnce() + Send + 'static + UnwindSafe,

Schedule a closure to be run.

This method can be used for “fire-and-forget” style calls, where the calling code doesn’t need to await the result.

Closure requirements:

• Send: since the closure will likely run on a different thread
• ’static: since it runs at an arbitrary time, so all references need to be ’static
• panic::UnwindSafe: if the closure panics, it should not corrupt any data

pub async fn run<F, T>(&self, delay: u32, closure: F) -> T

where F: FnOnce() -> T + Send + 'static + UnwindSafe, T: Send + 'static,

Schedule a closure to be run and get a Future for the result

Closure requirements:

• Send: since the closure will likely run on a different thread
• ’static: since it runs at an arbitrary time, so all references need to be ’static
• panic::UnwindSafe: if the closure panics, it should not corrupt any data

Trait Implementations

impl<UT> ConvertError<UT> for ForeignExecutor

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<ForeignExecutor, Error>

impl Debug for ForeignExecutor

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

Formats the value using the given formatter.

impl Drop for ForeignExecutor

fn drop(&mut self)

Executes the destructor for this type.

impl<UT> FfiConverter<UT> for ForeignExecutor

FFI support for ForeignExecutor

These are passed over the FFI as opaque pointer-sized types representing the foreign executor. The foreign bindings may use an actual pointer to the executor object, or a usized integer handle.

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = ForeignExecutorHandle

The low-level type used for passing values of this type over the FFI.

fn lower( executor: ForeignExecutor, ) -> <ForeignExecutor as FfiConverter<UT>>::FfiType

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn write(executor: ForeignExecutor, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_lift( executor: <ForeignExecutor as FfiConverter<UT>>::FfiType, ) -> Result<ForeignExecutor, Error>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn try_read(buf: &mut &[u8]) -> Result<ForeignExecutor, Error>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for ForeignExecutor

const TYPE_ID_META: MetadataBuffer

type FfiType = <ForeignExecutor as FfiConverter<UT>>::FfiType

fn try_lift( v: <ForeignExecutor as Lift<UT>>::FfiType, ) -> Result<ForeignExecutor, Error>

fn try_read(buf: &mut &[u8]) -> Result<ForeignExecutor, Error>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for ForeignExecutor

type LiftType = ForeignExecutor

impl<UT> LiftReturn<UT> for ForeignExecutor

const TYPE_ID_META: MetadataBuffer

fn lift_callback_return(buf: RustBuffer) -> ForeignExecutor

Lift a Rust value for a callback interface method result

fn lift_callback_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for ForeignExecutor

const TYPE_ID_META: MetadataBuffer

type FfiType = <ForeignExecutor as FfiConverter<UT>>::FfiType

fn lower(obj: ForeignExecutor) -> <ForeignExecutor as Lower<UT>>::FfiType

fn write(obj: ForeignExecutor, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerReturn<UT> for ForeignExecutor

const TYPE_ID_META: MetadataBuffer

type ReturnType = <ForeignExecutor as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return( obj: ForeignExecutor, ) -> Result<<ForeignExecutor as LowerReturn<UT>>::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts