HH\Map::toImmSet

Returns an immutable set (ImmSet) based on the values of the current Map

Description

public function toImmSet(): ImmSet<Tv>

Return Values

Examples

This example shows that converting a Map to an ImmSet also removes duplicate values:

<?hh

namespace Hack\UserDocumentation\API\Examples\Map\ToImmSet;

// This Map contains repetitions of the hex codes for 'red' and 'blue'
$m = Map {
  'red' => '#ff0000',
  'also red' => '#ff0000',
  'green' => '#00ff00',
  'another red' => '#ff0000',
  'blue' => '#0000ff',
  'another blue' => '#0000ff',
  'yellow' => '#ffff00',
};

$imm_set = $m->toImmSet();

var_dump($imm_set instanceof \HH\ImmSet);
var_dump($imm_set);
Output
bool(true)
object(HH\ImmSet)#2 (4) {
  string(7) "#ff0000"
  string(7) "#00ff00"
  string(7) "#0000ff"
  string(7) "#ffff00"
}