installWithProgress abstract method

Stream<int> installWithProgress(
  1. ModelSource source, {
  2. CancelToken? cancelToken,
})

Installs the model with progress tracking

Returns a stream of progress percentages (0-100)

Parameters:

  • source: The model source to install from
  • cancelToken: Optional token for cancelling the installation

Note: Some sources may not support true progress:

  • AssetSource: simulates progress (copy is instant)
  • BundledSource: returns 100 immediately (no download)
  • FileSource: returns 100 immediately (just registration)

Example:

final cancelToken = CancelToken();

try {
  await for (final progress in handler.installWithProgress(
    source,
    cancelToken: cancelToken,
  )) {
    print('Progress: $progress%');
  }
} catch (e) {
  if (CancelToken.isCancel(e)) {
    print('Installation cancelled');
  }
}

Throws:

Implementation

Stream<int> installWithProgress(
  ModelSource source, {
  CancelToken? cancelToken,
});