LuaCoroutineLib abstract

abstractclassLuaCoroutineLib

Abstract interface for Lua coroutine operations. Implements the coroutine library functionality.

Implementers

• LuaState

Constructors

LuaCoroutineLib()

LuaCoroutineLib()

Properties

hashCode no setter inherited

intgethashCode

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

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods

callCoroutineAsync()

Future<void>callCoroutineAsync(intnArgs)

Async counterpart of call for the first invocation of a coroutine.

Like LuaBasicAPI.callAsync but additionally sets the _insideResumeAsync flag on the coroutine thread so that host async functions called via plain CALL (without await) inside the coroutine body are transparently awaited. Use this at the first resume of a coroutine where resumeAsync cannot be used because the closure has not yet started executing.

Implementation

Future<void> callCoroutineAsync(int nArgs);

clearThreadWeakRef()

voidclearThreadWeakRef()

Clears weak references to dead threads.

Implementation

void clearThreadWeakRef();

debugThread()

StringdebugThread()

Returns debug information about all threads.

Implementation

String debugThread();

getCurrentNResults()

intgetCurrentNResults()

Gets the number of expected results for current closure.

Implementation

int getCurrentNResults();

getStatus()

ThreadStatusgetStatus()

Gets the current thread status.

Implementation

ThreadStatus getStatus();

newThread()

LuaStatenewThread()

Creates a new thread (coroutine) that shares the global environment.

Implementation

LuaState newThread();

noSuchMethod() inherited

dynamicnoSuchMethod(Invocationinvocation)

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

popObject()

Object?popObject()

Pops and returns the top value from the stack as a Dart object.

Implementation

Object? popObject();

popStackFrame()

voidpopStackFrame()

Pops the top stack frame (used after yield is caught).

Implementation

void popStackFrame();

pushThread()

voidpushThread(LuaStateL)

Pushes a thread onto the stack.

Implementation

void pushThread(LuaState L);

resetTopClosureNResults()

voidresetTopClosureNResults(intnResults)

Resets the expected number of results for the top closure.

Implementation

void resetTopClosureNResults(int nResults);

resume()

voidresume(intnArgs)

Resumes a suspended coroutine.

Implementation

void resume(int nArgs);

resumeAsync()

Future<void>resumeAsync(intnArgs)

Asynchronously resumes a suspended coroutine.

Use this when the coroutine body may call host-registered async functions (registered via LuaAuxLib.registerAsync) without the await keyword. The async dispatch in LuaStateImpl treats the coroutine thread as the suspension point, so async calls inside the coroutine body are awaited transparently.

Implementation

Future<void> resumeAsync(int nArgs);

runningId()

intrunningId()

Returns the unique ID of this thread.

Implementation

int runningId();

setStatus()

voidsetStatus(ThreadStatusstatus)

Sets the thread status.

Implementation

void setStatus(ThreadStatus status);

toString() inherited

StringtoString()

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

toThread()

LuaState?toThread(intidx)

Converts the value at the given index to a Lua thread (coroutine). Returns null if the value is not a thread.

Implementation

LuaState? toThread(int idx);

traceStack()

StringtraceStack()

Returns a stack trace for debugging.

Implementation

String traceStack();

xmove()

voidxmove(LuaStatefrom,intn)

Moves n values from one state to another. Pops the values from 'from' and pushes them to this state.

Implementation

void xmove(LuaState from, int n);

Operators

operator ==() inherited

booloperator ==(Objectother)

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