DocumentationHackReferenceClassHH\SettoImmSet

HH\Set::toImmSet

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

public function toImmSet(): ImmSet<Tv>;

This method is interchangeable with immutable().

Returns

ImmSet<Tv> - an ImmSet that is a deep copy of the current Set.

Examples

$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->toImmSet();

expects_immutable($immutable_s);

Output

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