Deprecate Await::f2c and Await::g2c, use Await::run instead.

SOF3 · Mar 20, 2022 · a75f087 · a75f087
1 parent 9e290d3
commit a75f087
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/await-generator/src/SOFe/AwaitGenerator/Await.php b/await-generator/src/SOFe/AwaitGenerator/Await.php
@@ -82,9 +82,30 @@ class Await extends PromiseState{
 	protected final function __construct(){
 	}
 
+	/**
+	 * Executes a generator in the background.
+	 *
+	 * @param Closure|Generator $generator
+	 * @phpstan-param Generator<mixed, Await::RESOLVE|null|Await::RESOLVE_MULTI|Await::REJECT|Await::ONCE|Await::ALL|Await::RACE|Generator, mixed, T>|Closure(): Generator<mixed, Await::RESOLVE|null|Await::RESOLVE_MULTI|Await::REJECT|Await::ONCE|Await::ALL|Await::RACE|Generator, mixed, T> $generator
+	 */
+	public static function run(Closure|Generator $generator) : void{
+		if($generator instanceof Closure) {
+			$generator = $generator();
+		}
+
+		/** @var Await<T> $await */
+		$await = new Await();
+		$await->generator = $generator;
+		$await->onComplete = null;
+
+		$await->wakeupFlat(fn() => $generator->rewind());
+	}
+
 	/**
 	 * Converts a `Function<AwaitGenerator>` to a VoidCallback
 	 *
+	 * @deprecated Use `Await::run` instead.
+	 *
 	 * @param callable            $closure
 	 * @phpstan-param callable(): Generator<mixed, Await::RESOLVE|null|Await::RESOLVE_MULTI|Await::REJECT|Await::ONCE|Await::ALL|Await::RACE|Generator, mixed, T> $closure
 	 * @param callable|null       $onComplete
@@ -101,6 +122,8 @@ public static function f2c(callable $closure, ?callable $onComplete = null, $cat
 	/**
 	 * Converts an AwaitGenerator to a VoidCallback
 	 *
+	 * @deprecated Use `Await::run` instead.
+	 *
 	 * @param Generator           $generator
 	 * @phpstan-param Generator<mixed, Await::RESOLVE|null|Await::RESOLVE_MULTI|Await::REJECT|Await::ONCE|Await::ALL|Await::RACE|Generator, mixed, T> $generator
 	 * @param callable|null       $onComplete