HH\Set::toImmMap

Returns an immutable map (ImmMap) based on the values of the current Set

Description

public function toImmMap(): ImmMap<mixed, Tv>

Each key of the Map will be the same as its value.

Return Values

  • ImmMap<mixed, Tv> - an ImmMap that that contains the values of the current Set, with each key of the Map being the same as its value.

Examples

<?hh

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

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

$imm_map = $s->toImmMap();

var_dump($imm_map instanceof \HH\ImmMap);
var_dump($imm_map);
Output
bool(true)
object(HH\ImmMap)#2 (4) {
  ["red"]=>
  string(3) "red"
  ["green"]=>
  string(5) "green"
  ["blue"]=>
  string(4) "blue"
  ["yellow"]=>
  string(6) "yellow"
}