HH\Lib\C\first

Meta Engineer?

This is available as C\first in the www repository.

Returns the first element of the given Traversable, or null if the Traversable is empty

namespace HH\Lib\C;

function first<T>(
  Traversable<T> $traversable,
): ?T;
  • For non-empty Traversables, see C\firstx.
  • For possibly null Traversables, see C\nfirst.
  • For single-element Traversables, see C\onlyx.
  • For Awaitables that yield Traversables, see C\first_async.

Time complexity: O(1) Space complexity: O(1)

Parameters

Returns

  • ?T

Examples

$strings = vec["a", "b", "c"];
$first_string = C\first($strings);
echo "First string in traversable: $first_string \n";
//Output: First string in traversable: a 

$empty_traversable = vec[];
$first_element = C\first($empty_traversable);
$first_element_as_string = $first_element ?? "null";
echo "First element in empty traversable: $first_element_as_string";
//Output: First element in empty traversable: null