Skip to main content

/

Docs

Log in

Mojo struct

Coroutine

Represents a coroutine.

Coroutines can pause execution saving the state of the program (including values of local variables and the location of the next instruction to be executed). When the coroutine is resumed, execution continues from where it left off, with the saved state restored.

Parameters​

  • ​type (AnyType): Type of value returned upon completion of the coroutine.
  • ​lifetimes (lifetime.set): The lifetime of the coroutine's captures.

Implemented traits​

AnyType

Methods​

__init__​

__init__(inout self: Self, handle: !co.routine)

Construct a coroutine object from a handle.

Args:

  • ​handle (!co.routine): The init handle.

__del__​

__del__(owned self: Self)

Destroy the coroutine object.

__await__​

__await__(owned self: Self) -> type

Suspends the current coroutine until the coroutine is complete.

Returns:

The coroutine promise.

Was this page helpful?