use_isolate 0.3.0+1 use_isolate: ^0.3.0+1 copied to clipboard
A Hook wrapper of integral_isolates making multi-threading easy using hooks
The power of integral_isolates neatly packed up in a hook.
Usage #
Using an isolate in a hook has never been simpler. With the use of useIsolate()
you can get a
compute function similar to compute
but that lives longer. You don't have to care about lifecycle, the hook handles that for you.
Example:
class TestingIsolateHook extends HookWidget {
const TestingIsolateHook({super.key});
@override
Widget build(BuildContext context) {
final isolate = useIsolate();
final number = useState(1);
return TextButton(
onPressed: () async {
final isPrime = await isolate.compute(_isPrime, number.value);
print('${number.value} is a prime number? ${isPrime}');
number.value += 1;
},
child: Text(
'Check if ${number.value} is a prime number',
),
);
}
static bool _isPrime(int value) {
if (value == 1) {
return false;
}
for (int i = 2; i < value; ++i) {
if (value % i == 0) {
return false;
}
}
return true;
}
}
Just as integral_isolates, this hook supports backpressure strategies, just send a strategy in as parameter:
final isolate = useIsolate(backpressureStrategy: DiscardNewBackPressureStrategy());
What about TailoredStatefulIsolate? #
You might know that you can create tailored stateful isolates with integral_isolates. This is now also possible with use_isolate.
To create a tailored isolate that takes a double
as the input parameter and returns an int
, just use this hook
instead:
final isolate = useTailoredIsolate<double, int>();
Breaking change #
use_isolate
v0.3.0: now returns the whole isolate, requiring you to explicitly type outisolate.compute(..)
instead of justisolate(..)
. This is due to support forisolate.computeStream(..)
is added.
Additional information #
You could expect this API to be mostly stable, but implementation of the underlying package (integral_isolates) is not fully finalized yet, and there is more features coming before both packages can count as stable.