Dart API

Appearance

dart:ffi›Classes›Abi

Abi ​

class Abi

Annotations: @Since.new('2.16')

An application binary interface (ABI).

An ABI defines the memory layout of data and the function call protocol for native code. It is usually defined by the an operating system for each architecture that operating system runs on.

The Dart VM can run on a variety of operating systems and architectures. Supported ABIs are represented by Abi objects. See values for all the supported ABIs.

Constructors ​

Abi.current() factory ​

factory Abi.current()

The ABI the Dart VM is currently running on.

Implementation
dart
external factory Abi.current();

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

String toString()

A string representation of this ABI.

The string is equal to the 'on' part from Platform.version and dart --version.

Implementation
dart
@override
String toString() => '${_os.name}_${_architecture.name}';

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);

Constants ​

androidArm ​

const Abi androidArm

The application binary interface for Android on the Arm architecture.

Implementation
dart
static const androidArm = _androidArm;

androidArm64 ​

const Abi androidArm64

The application binary interface for Android on the Arm64 architecture.

Implementation
dart
static const androidArm64 = _androidArm64;

androidIA32 ​

const Abi androidIA32

The application binary interface for Android on the IA32 architecture.

Implementation
dart
static const androidIA32 = _androidIA32;

androidRiscv64 ​

const Abi androidRiscv64

The application binary interface for Android on 64-bit RISC-V.

Implementation
dart
static const androidRiscv64 = _androidRiscv64;

androidX64 ​

const Abi androidX64

The application binary interface for Android on the X64 architecture.

Implementation
dart
static const androidX64 = _androidX64;

fuchsiaArm64 ​

const Abi fuchsiaArm64

The application binary interface for Fuchsia on the Arm64 architecture.

Implementation
dart
static const fuchsiaArm64 = _fuchsiaArm64;

fuchsiaRiscv64 ​

const Abi fuchsiaRiscv64

The application binary interface for Fuchsia on the Riscv64 architecture.

Implementation
dart
static const fuchsiaRiscv64 = _fuchsiaRiscv64;

fuchsiaX64 ​

const Abi fuchsiaX64

The application binary interface for Fuchsia on the X64 architecture.

Implementation
dart
static const fuchsiaX64 = _fuchsiaX64;

iosArm ​

const Abi iosArm

The application binary interface for iOS on the Arm architecture.

Implementation
dart
static const iosArm = _iosArm;

iosArm64 ​

const Abi iosArm64

The application binary interface for iOS on the Arm64 architecture.

Implementation
dart
static const iosArm64 = _iosArm64;

iosX64 ​

const Abi iosX64

The application binary interface for iOS on the X64 architecture.

Implementation
dart
static const iosX64 = _iosX64;

linuxArm ​

const Abi linuxArm

The application binary interface for Linux on the Arm architecture.

Does not distinguish between hard and soft fp. Currently, no uses of Abi require this distinction.

Implementation
dart
static const linuxArm = _linuxArm;

linuxArm64 ​

const Abi linuxArm64

The application binary interface for linux on the Arm64 architecture.

Implementation
dart
static const linuxArm64 = _linuxArm64;

linuxIA32 ​

const Abi linuxIA32

The application binary interface for linux on the IA32 architecture.

Implementation
dart
static const linuxIA32 = _linuxIA32;

linuxRiscv32 ​

const Abi linuxRiscv32

The application binary interface for linux on 32-bit RISC-V.

Implementation
dart
static const linuxRiscv32 = _linuxRiscv32;

linuxRiscv64 ​

const Abi linuxRiscv64

The application binary interface for linux on 64-bit RISC-V.

Implementation
dart
static const linuxRiscv64 = _linuxRiscv64;

linuxX64 ​

const Abi linuxX64

The application binary interface for linux on the X64 architecture.

Implementation
dart
static const linuxX64 = _linuxX64;

macosArm64 ​

const Abi macosArm64

The application binary interface for MacOS on the Arm64 architecture.

Implementation
dart
static const macosArm64 = _macosArm64;

macosX64 ​

const Abi macosX64

The application binary interface for MacOS on the X64 architecture.

Implementation
dart
static const macosX64 = _macosX64;

values ​

const List<Abi> values

The ABIs that the DartVM can run on.

Does not contain a macosIA32. We have stopped supporting 32-bit MacOS.

Implementation
dart
static const values = [
  androidArm,
  androidArm64,
  androidIA32,
  androidX64,
  androidRiscv64,
  fuchsiaArm64,
  fuchsiaX64,
  fuchsiaRiscv64,
  iosArm,
  iosArm64,
  iosX64,
  linuxArm,
  linuxArm64,
  linuxIA32,
  linuxX64,
  linuxRiscv32,
  linuxRiscv64,
  macosArm64,
  macosX64,
  windowsArm64,
  windowsIA32,
  windowsX64,
];

windowsArm64 ​

const Abi windowsArm64

The application binary interface for Windows on the Arm64 architecture.

Implementation
dart
static const windowsArm64 = _windowsArm64;

windowsIA32 ​

const Abi windowsIA32

The application binary interface for Windows on the IA32 architecture.

Implementation
dart
static const windowsIA32 = _windowsIA32;

windowsX64 ​

const Abi windowsX64

The application binary interface for Windows on the X64 architecture.

Implementation
dart
static const windowsX64 = _windowsX64;