fromByteStream static method

Future<bool> fromByteStream(Stream<List<int>> stream, { required String mime, required String name, SaveFileExtensionBehavior extensionBehavior = SaveFileExtensionBehavior.replace, })

Saves provided byte stream to file in a location accessible by the user.

Returns true if the file has been saved and false if user has cancelled the action (can happen only on Android). Throws if there's been an error.

Both mime and name parameters must be provided. To allow for automatic inference, use fromFile or fromUrl methods.

The extensionBehavior parameter determines what to do if the extension of provided or inferred name does not match the provided or inferred mime type. See SaveFileExtensionBehavior for documentation of the available options.

Implementation

static Future<bool> fromByteStream(
  Stream<List<int>> stream, {
  required String mime,
  required String name,
  SaveFileExtensionBehavior extensionBehavior = SaveFileExtensionBehavior.replace,
}) async {
  final metadata = SaveFileMetadata(object: '<raw byte stream>', name: name, mime: mime);
  return _impl.fromByteStream(stream, ExtensionHelper.ensureValid(metadata, extensionBehavior));
}