NativeRuntime abstract final

abstract final class NativeRuntime

Annotations: @Since.new('3.0')

Functionality available on the native runtime.

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

external int get hashCode;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

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:

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:

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

@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

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

external bool operator ==(Object other);

Static Properties

buildId no setter

String? get buildId

The build ID for the running application.

The build ID of an application is a string containing a hexadecimal representation of an arbitrarily sized sequence of bytes. This string can be used to match a specific ahead-of-time compiled version of an application, for example, to determine which debugging artifacts emitted during compilation should be used to translate crash and error reports.

The build ID is only available for ahead-of-time compiled programs. If a build ID is not available, the value is null.

Implementation

@Since('3.1')
external static String? get buildId;

Static Methods

stopStreamingTimeline()

void stopStreamingTimeline()

Finishes capturing of timeline data started by streamTimelineTo.

Implementation

@Since('3.11')
external static void stopStreamingTimeline();

streamTimelineTo()

void streamTimelineTo(
  TimelineRecorder recorder, {
  String? path,
  List<TimelineStream> streams = const [TimelineStream.dart, TimelineStream.gc],
  bool enableProfiler = false,
  Duration samplingInterval = const Duration(microseconds: 1000),
})

Tells runtime to write timeline data using recorder.

Timeline recording is enabled for the whole runtime and not for any specific isolate or isolate group.

Once started timeline recording will continue until it is stopped by stopStreamingTimeline.

Some recorders write into a specific file (specified by path), while others write to system wide recording buffer.

The streams specifies which timeline streams to enable. Only TimelineStream.dart and TimelineStream.gc are enabled by default.

If recorder supports profiling data then setting enableProfiler to true will turn on sampling profiler, which will collect profiling samples with frequency specified by samplingInterval. These samples will then written into the timeline.

Throws ArgumentError iff:

• path is specified but recorder writes to a fixed location.
• path is not specified and recorder requires it.
• enableProfiler is true and recorder does not support writing out profiling data.
• samplingInterval is too small.

Implementation

@Since('3.11')
external static void streamTimelineTo(
  TimelineRecorder recorder, {
  String? path,
  List<TimelineStream> streams = const [
    TimelineStream.dart,
    TimelineStream.gc,
  ],
  bool enableProfiler = false,
  Duration samplingInterval = const Duration(microseconds: 1000),
});

writeHeapSnapshotToFile()

void writeHeapSnapshotToFile(String filepath)

Writes a snapshot of the heap to filepath.

The filepath should be a native file path that can be opened for writing. Relative paths will be relative to the current working directory. If the file already exists it will be overwritten.

WARNING: Only works on a native runtime in certain configurations. An UnsupportedError error is thrown if this functionality is not available (e.g. in product mode, in non-standalone VM, ...)

NOTE: This is an experimental function. We reserve the right to change or remove it in the future.

Implementation

external static void writeHeapSnapshotToFile(String filepath);