1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
//! Manages receiving and sending values across the FFI boundary.
use std::marker::PhantomData;
/// The representation of a Dart object outside of the Dart heap.
///
/// Its implementation lies with the Dart language and therefore should not be
/// depended on to be stable.
pub use crate::ffi::*;
/// A wrapper around a Dart [`Isolate`].
#[derive(Clone)]
pub struct Rust2Dart {
pub(crate) channel: Channel,
}
const RUST2DART_ACTION_SUCCESS: i32 = 0;
const RUST2DART_ACTION_ERROR: i32 = 1;
const RUST2DART_ACTION_CLOSE_STREAM: i32 = 2;
// api signatures is similar to Flutter Android's callback https://api.flutter.dev/javadoc/io/flutter/plugin/common/MethodChannel.Result.html
impl Rust2Dart {
/// Create a new wrapper from a raw port.
pub fn new(port: MessagePort) -> Self {
Rust2Dart {
channel: Channel::new(port),
}
}
/// Send a success message back to the specified port.
pub fn success(&self, result: impl IntoDart) -> bool {
self.channel.post(vec![
RUST2DART_ACTION_SUCCESS.into_dart(),
result.into_dart(),
])
}
/// Send an error back to the specified port.
pub fn error(&self, error_code: String, error_message: String) -> bool {
self.error_full(error_code, error_message, ())
}
/// Send a detailed error back to the specified port.
pub fn error_full(
&self,
error_code: String,
error_message: String,
error_details: impl IntoDart,
) -> bool {
self.channel.post(vec![
RUST2DART_ACTION_ERROR.into_dart(),
error_code.into_dart(),
error_message.into_dart(),
error_details.into_dart(),
])
}
/// Close the stream and ignore further messages.
pub fn close_stream(&self) -> bool {
self.channel
.post(vec![RUST2DART_ACTION_CLOSE_STREAM.into_dart()])
}
}
/// A callback that receives the return value of Rust functions.
pub struct TaskCallback {
rust2dart: Rust2Dart,
}
impl TaskCallback {
/// Create a new callback from a port wrapper.
pub fn new(rust2dart: Rust2Dart) -> Self {
Self { rust2dart }
}
/// Create a new [StreamSink] of the specified type.
pub fn stream_sink<T: IntoDart>(&self) -> StreamSink<T> {
StreamSink::new(self.rust2dart.clone())
}
}
/// A handle to a [`web_sys::BroadcastChannel`].
#[derive(Clone)]
pub struct ChannelHandle(pub String);
impl ChannelHandle {
#[cfg(wasm)]
pub fn port(&self) -> MessagePort {
PortLike::broadcast(&self.0)
}
}
/// A sink to send asynchronous data back to Dart.
/// Represented as a Dart
/// [`Stream`](https://api.dart.dev/stable/dart-async/Stream-class.html).
#[derive(Clone)]
pub struct StreamSink<T: IntoDart> {
#[cfg(not(wasm))]
rust2dart: Rust2Dart,
#[cfg(wasm)]
handle: ChannelHandle,
_phantom_data: PhantomData<T>,
}
impl<T: IntoDart> StreamSink<T> {
/// Create a new sink from a port wrapper.
pub fn new(rust2dart: Rust2Dart) -> Self {
#[cfg(wasm)]
let name = rust2dart
.channel
.broadcast_name()
.expect("Not a BroadcastChannel");
Self {
#[cfg(not(wasm))]
rust2dart,
#[cfg(wasm)]
handle: ChannelHandle(name),
_phantom_data: PhantomData,
}
}
fn rust2dart(&self) -> Rust2Dart {
#[cfg(not(wasm))]
return self.rust2dart.clone();
#[cfg(wasm)]
Rust2Dart::new(self.handle.port())
}
/// Add data to the stream. Returns false when data could not be sent,
/// or the stream has been closed.
pub fn add(&self, value: T) -> bool {
self.rust2dart().success(value)
}
/// Close the stream and ignore further messages. Returns false when
/// the stream could not be closed, or when it has already been closed.
pub fn close(&self) -> bool {
self.rust2dart().close_stream()
}
}