Skip to main content

API

TransportFilesFactory​

Declaration
class TransportFilesFactory {
  TransportFile open(
    String path, {
    TransportFileMode mode = TransportFileMode.readWriteAppend,
    bool create = false,
    bool truncate = false,
  })
}

Methods​

open​

Opens a new file for manipulations.

TransportFile​

Declaration
class TransportFile {
  final File delegate;
  Stream<TransportPayload> get inbound
  bool get active
  void read({int blocksCount = 1, int offset = 0})
  void writeSingle(Uint8List bytes, {void Function(Exception error)? onError, void Function()? onDone})
  void writeMany(List<Uint8List> bytes, {void Function(Exception error)? onError, void Function()? onDone})
  Future<Uint8List> load({int blocksCount = 1, int offset = 0})
  Future<void> close({Duration? gracefulTimeout}) => _file.close(gracefulTimeout: gracefulTimeout)
}

Properties​

delegate​

Dart file object.

inbound​

Stream for inbound (read) payloads.

active​

Is the file open?

Methods​

read​

Sends a read operation to the file.

writeSingle​

Writes a single buffer to the file.

writeMany​

Writes many buffers to the file.

load​

Reads all the file content.

close​

Closes the file.