HH\Set::immutable

Returns an immutable (ImmSet), deep copy of the current Set.

Description

public function immutable(): ImmSet<Tv>

Returns an immutable (ImmSet), deep copy of the current Set.

This method is interchangeable with toImmSet().

Return Values

Examples

<?hh

namespace Hack\UserDocumentation\API\Examples\Set\Immutable;

$s = Set {'red', 'green', 'blue', 'yellow'};

function expects_immutable(ImmSet<string> $is): void {
  var_dump($is);
}

// Get a deep, immutable copy of $s
$immutable_s = $s->immutable();

expects_immutable($immutable_s);
Output
object(HH\ImmSet)#2 (4) {
  string(3) "red"
  string(5) "green"
  string(4) "blue"
  string(6) "yellow"
}