IsolateMirror abstract

abstract class IsolateMirror implements Mirror

An IsolateMirror reflects an isolate.

Implemented types

• Mirror

Constructors

IsolateMirror()

IsolateMirror()

Properties

debugName no setter

String get debugName

A unique name used to refer to the isolate in debugging messages.

Implementation

String get debugName;

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;

isCurrent no setter

bool get isCurrent

Whether this mirror reflects the currently running isolate.

Implementation

bool get isCurrent;

rootLibrary no setter

LibraryMirror get rootLibrary

The root library for the reflected isolate.

Implementation

LibraryMirror get rootLibrary;

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

loadUri()

Future<LibraryMirror> loadUri(Uri uri)

Loads the library at the given uri into this isolate.

WARNING: You are strongly encouraged to use Isolate.spawnUri instead when possible. IsolateMirror.loadUri should only be used when synchronous communication or shared state with dynamically loaded code is needed.

If a library with the same canonicalized uri has already been loaded, the existing library will be returned. (The isolate will not load a new copy of the library.)

This behavior is similar to the behavior of an import statement that appears in the root library, except that the import scope of the root library is not changed.

Implementation

Future<LibraryMirror> loadUri(Uri uri);

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 ==() override

bool operator ==(Object other)

Whether other is an IsolateMirror on the same isolate as this mirror.

The equality holds if and only if

1. other is a mirror of the same kind, and
2. the isolate being reflected by this mirror is the same isolate being reflected by other.

Implementation

bool operator ==(Object other);