flutterCompute<T, U> function

Future<T> flutterCompute<T, U>(FutureOr<T> callback(U message), U message)

A function that spawns a flutter isolate and runs the provided callback on that isolate, passes it the provided message, and (eventually) returns the value returned by callback.

Since callback needs to be passed between isolates, it must be a top-level function or a static method.

Both the return type and the message type must be supported by SendPort.send stated in https://api.dart.dev/stable/dart-isolate/SendPort/send.html

Implementation

@pragma('vm:entry-point')
Future<T> flutterCompute<T, U>(
    FutureOr<T> Function(U message) callback, U message) async {
  final callbackHandle =
      PluginUtilities.getCallbackHandle(callback)!.toRawHandle();
  final completer = Completer<dynamic>();
  final port = RawReceivePort();
  port.handler = (dynamic response) {
    port.close();
    completer.complete(response);
  };

  FlutterIsolate? isolate;
  try {
    isolate = await FlutterIsolate.spawn(_isolateMain, {
      "callback": callbackHandle,
      "port": port.sendPort,
      "message": message,
    });
  } catch (_) {
    port.close();
    isolate?.kill();
    rethrow;
  }
  final response = await completer.future;
  isolate.kill();

  if (response == null) {
    throw RemoteError("Isolate exited without result or error.", "");
  }
  if (response["status"] == _Status.ok.index) {
    return response["result"] as T;
  } else {
    await Future<Never>.error(
      RemoteError(response["error"], response["stackTrace"]),
    );
  }
}