BinaryCache

class BinaryCache

Manages cached binary files.

Constructors

BinaryCache()

BinaryCache()

Properties

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

dart

external int get hashCode;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

dart

external Type get runtimeType;

Methods

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

dart

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

dart

external String toString();

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

dart

external bool operator ==(Object other);

Static Methods

clearAll()

Future<void> clearAll()

Clears all cached versions.

Implementation

dart

static Future<void> clearAll() async {
  final cacheDir = await getCacheDir();
  final dir = Directory(cacheDir);

  if (await dir.exists()) {
    await dir.delete(recursive: true);
  }
}

clearVersion()

Future<void> clearVersion(String version)

Clears the cache for a specific version.

Implementation

dart

static Future<void> clearVersion(String version) async {
  final versionDir = await getVersionCacheDir(version);
  final dir = Directory(versionDir);

  if (await dir.exists()) {
    await dir.delete(recursive: true);
  }
}

ensureVersionCacheDir()

Future<String> ensureVersionCacheDir(String version)

Ensures the cache directory exists for a specific version.

Implementation

dart

static Future<String> ensureVersionCacheDir(String version) async {
  final versionDir = await getVersionCacheDir(version);
  final dir = Directory(versionDir);

  if (!await dir.exists()) {
    await dir.create(recursive: true);
  }

  return versionDir;
}

formatBytes()

String formatBytes(int bytes)

Formats bytes to a human-readable string.

Implementation

dart

static String formatBytes(int bytes) {
  if (bytes < 1024) return '$bytes B';
  if (bytes < 1024 * 1024) return '${(bytes &#47; 1024).toStringAsFixed(2)} KB';
  if (bytes < 1024 * 1024 * 1024) {
    return '${(bytes &#47; (1024 * 1024)).toStringAsFixed(2)} MB';
  }
  return '${(bytes &#47; (1024 * 1024 * 1024)).toStringAsFixed(2)} GB';
}

getBinaryPath()

Future<String?> getBinaryPath(String version, String binaryName)

Checks if a binary exists in cache for the given version and name.

Implementation

dart

static Future<String?> getBinaryPath(
  String version,
  String binaryName,
) async {
  final versionDir = await getVersionCacheDir(version);
  final binaryPath = p.join(versionDir, binaryName);

  final file = File(binaryPath);
  if (await file.exists()) {
    return binaryPath;
  }

  return null;
}

getCacheDir()

Future<String> getCacheDir()

Gets the cache directory path.

macOS/Linux: ~/.cache/network_debugger/
Windows: %LOCALAPPDATA%\network_debugger\Cache\

Implementation

dart

static Future<String> getCacheDir() async {
  if (Platform.isWindows) {
    &#47;&#47; On Windows, use LOCALAPPDATA
    final appData = Platform.environment['LOCALAPPDATA'];
    if (appData == null) {
      throw CacheException('LOCALAPPDATA environment variable not found');
    }
    return p.join(appData, _cacheSubdir, 'Cache');
  } else {
    &#47;&#47; On macOS&#47;Linux, prefer XDG_CACHE_HOME or fallback to ~&#47;.cache
    final xdgCache = Platform.environment['XDG_CACHE_HOME'];
    if (xdgCache != null) {
      return p.join(xdgCache, _cacheSubdir);
    }

    &#47;&#47; Fallback to home directory
    final homeDir = Platform.environment['HOME'];
    if (homeDir == null) {
      throw CacheException('HOME environment variable not found');
    }
    return p.join(homeDir, '.cache', _cacheSubdir);
  }
}

getCacheSize()

Future<int> getCacheSize()

Gets the total size of the cache in bytes.

Implementation

dart

static Future<int> getCacheSize() async {
  final cacheDir = await getCacheDir();
  final dir = Directory(cacheDir);

  if (!await dir.exists()) {
    return 0;
  }

  var totalSize = 0;

  await for (final entity in dir.list(recursive: true)) {
    if (entity is File) {
      final stat = await entity.stat();
      totalSize += stat.size;
    }
  }

  return totalSize;
}

getVersionCacheDir()

Future<String> getVersionCacheDir(String version)

Gets the version-specific cache directory.

Implementation

dart

static Future<String> getVersionCacheDir(String version) async {
  final cacheDir = await getCacheDir();
  return p.join(cacheDir, version);
}

listVersions()

Future<List<String>> listVersions()

Lists all cached versions.

Implementation

dart

static Future<List<String>> listVersions() async {
  final cacheDir = await getCacheDir();
  final dir = Directory(cacheDir);

  if (!await dir.exists()) {
    return [];
  }

  final entities = await dir.list().toList();
  final versions = <String>[];

  for (final entity in entities) {
    if (entity is Directory) {
      versions.add(p.basename(entity.path));
    }
  }

  return versions;
}

validateBinary()

Future<bool> validateBinary(String binaryPath)

Validates that a cached binary is executable.

Implementation

dart

static Future<bool> validateBinary(String binaryPath) async {
  final file = File(binaryPath);

  if (!await file.exists()) {
    return false;
  }

  &#47;&#47; Check if file is executable (on Unix-like systems)
  if (!Platform.isWindows) {
    final stat = await file.stat();
    &#47;&#47; Check if file has execute permission (simplified check)
    final mode = stat.mode;
    final isExecutable =
        (mode & 0x49) != 0; &#47;&#47; Check user, group, or other execute bit

    if (!isExecutable) {
      return false;
    }
  }

  return true;
}

BinaryCache ​

Constructors ​

BinaryCache() ​

Properties ​

hashCode no setter inherited ​

runtimeType no setter inherited ​

Methods ​

noSuchMethod() inherited ​

toString() inherited ​

Operators ​

operator ==() inherited ​

Static Methods ​

clearAll() ​

clearVersion() ​

ensureVersionCacheDir() ​

formatBytes() ​

getBinaryPath() ​

getCacheDir() ​

getCacheSize() ​

getVersionCacheDir() ​

listVersions() ​

validateBinary() ​

BinaryCache

Constructors

BinaryCache()

Properties

hashCode no setter inherited

runtimeType no setter inherited

Methods

noSuchMethod() inherited

toString() inherited

Operators

operator ==() inherited

Static Methods

clearAll()

clearVersion()

ensureVersionCacheDir()

formatBytes()

getBinaryPath()

getCacheDir()

getCacheSize()

getVersionCacheDir()

listVersions()

validateBinary()