HH\Asio\vfkw

Returns an Awaitable of Vector of ResultOrExceptionWrapper after a filtering operation has been applied to each key/value pair in the provided KeyedTraversable.

Description

function HH\Asio\vfkw(
  KeyedTraversable<Tk,T> $inputs,
  callable $callable,
): Awaitable<Vector<HH\Asio\ResultOrExceptionWrapper<T>>>

Returns an Awaitable of Vector of ResultOrExceptionWrapper after a filtering operation has been applied to each key/value pair in the provided KeyedTraversable.

This function is similar to vfk(), except the Vector in the returned Awaitable contains ResultOrExceptionWrappers instead of raw values.

This function is similar to Vector::filterWithKey(), but the mapping of the key/value pairs are done using Awaitables.

This function is called vfkw because we are returning a vector, doing a filtering operation that includes both keys and values, and each member of the Vector is wrapped by a ResultOrExceptionWrapper.

$callable must return an Awaitable of bool.

The ResultOrExceptionWrappers in the Vector of the returned Awaitable are not available until you await or join the returned Awaitable.

Parameters

  • KeyedTraversable<Tk,T> $inputs - The KeyedTraversable of keys and values to map.
  • callable $callable - The callable containing the Awaitable operation to apply to $inputs.

Return Values

Examples

<?hh

namespace Hack\UserDocumentation\API\Examples\HH\Asio\vfkw;

// Return all non-negative odd numbers
// Positive evens and odds at every third index filtered out,
// Negatives and zero cause exception
$odds = \HH\Asio\join(\HH\Asio\vfkw(
  Vector { -1, 0, 1, 2, 3, 4, 5 },

  async ($idx, $val) ==> {
    if ($val <= 0) {
      throw new \Exception("$val is non-positive");
    } else {
      return ($idx % 3) && ($val % 2);
    }
  },
));

foreach($odds as $result) {
  if ($result->isSucceeded()) {
    echo "Success: ";
    var_dump($result->getResult());
  } else {
    echo "Failed: ";
    var_dump($result->getException()->getMessage());
  }
}
Output
Failed: string(18) "-1 is non-positive"
Failed: string(17) "0 is non-positive"
Success: int(1)
Success: int(3)