Raise an exception to the async generator.


public function raise(
  Exception $e,
): Awaitable<?tuple>

Raise an exception to the async generator.

You should always await the returned Awaitable to get the actual key/value tuple.

If null is returned, that means you have reached the end of iteration.

You cannot call raise() without having the value returned from a previous call to raise(), next(), send(), having first awaited.


  • Exception $e - The exception to raise on the async generator.

Return Values

  • Awaitable<?tuple> - The Awaitable that produced the yielded key/value tuple after the exception is processed. What is returned is a tuple or null.