binary_reader.dart

part of hive;

/// The [BinaryReader] is used to bring data back from the binary format on the
/// disk.
abstract class BinaryReader {
  /// The UTF-8 decoder is used to decode Strings.
  static const utf8Decoder = Utf8Decoder();

  /// The number of bytes left in this entry.
  int get availableBytes;

  /// The number of read bytes.
  int get usedBytes;

  /// Skip n bytes.
  void skip(int bytes);

  /// Read a single byte.
  int readByte();

  /// Get a [Uint8List] view which contains the next [bytes] bytes.
  Uint8List viewBytes(int bytes);

  /// Get a [Uint8List] view which contains the next [bytes] bytes. This does
  /// not advance the internal read position.
  Uint8List peekBytes(int bytes);

  /// Read two bytes as 16-bit unsigned integer.
  int readWord();

  /// Read four bytes as 32-bit signed integer.
  int readInt32();

  /// Read four bytes as 32-bit unsigned integer.
  int readUint32();

  /// Read eight bytes as 64-bit signed integer.
  int readInt();

  /// Read eight bytes as 64-bit double.
  double readDouble();

  /// Read a boolean.
  bool readBool();

  /// Read [byteCount] bytes and decode an UTF-8 String.
  ///
  /// If [byteCount] is not provided, it is read first.
  String readString([
    int byteCount,
    Converter<List<int>, String> decoder = utf8Decoder,
  ]);

  /// Read an ASCII-String with [length].
  ///
  /// If [length] is not provided, it is read first.
  String readAsciiString([int length]);

  /// Read a list of bytes with [length].
  ///
  /// If [length] is not provided, it is read first.
  Uint8List readByteList([int length]);

  /// Read a list of integers with [length].
  ///
  /// If [length] is not provided, it is read first.
  List<int> readIntList([int length]);

  /// Read a list of doubles with [length].
  ///
  /// If [length] is not provided, it is read first.
  List<double> readDoubleList([int length]);

  /// Read a list of booleans with [length].
  ///
  /// If [length] is not provided, it is read first.
  List<bool> readBoolList([int length]);

  /// Read a list of Strings with [length].
  ///
  /// If [length] is not provided, it is read first.
  List<String> readStringList([
    int length,
    Converter<List<int>, String> decoder = utf8Decoder,
  ]);

  /// Read a list with [length].
  ///
  /// If [length] is not provided, it is read first.
  List readList([int length]);

  /// Read a map with [length] entries.
  ///
  /// If [length] is not provided, it is read first.
  Map readMap([int length]);

  /// Read a [HiveList] with [length].
  ///
  /// If [length] is not provided, it is read first.
  HiveList readHiveList([int length]);

  /// Read and decode any value.
  ///
  /// If [typeId] is not provided, it is read first.
  dynamic read([int typeId]);
}