gossamer - v9.2.0

gossamer/set

Types

Set

</>

A JS Set holding unique values of any type, preserving insertion order. Mutable — methods modify the set in place and return it for chaining.

For most Gleam use cases, prefer gleam/set.Set. This binding exists for JS interop where a JS Set is specifically required.

Object values (records, lists, tuples) are matched by JS reference identity, not value equality — two equal-by-value tuples constructed separately are distinct values. Primitive values (Int, Float, String, Bool) use value equality.

See Set on MDN.

pub type Set(value)

Values

add

</> 
pub fn add(to set: Set(value), value value: value) -> Set(value)

Adds a value to the set. Mutates the set.

clear

</> 
pub fn clear(set: Set(value)) -> Set(value)

Removes all values. Mutates the set.

delete

</> 
pub fn delete(
  from set: Set(value),
  value value: value,
) -> Set(value)

Removes the value from the set. Mutates the set.

difference

</> 
pub fn difference(
  from set: Set(value),
  without other: Set(value),
) -> Set(value)

Returns a new set containing values in this set but not in the other.

entries

</> 
pub fn entries(
  of set: Set(value),
) -> iterator.Iterator(#(value, value), Nil, Nil)

for_each

</> 
pub fn for_each(
  in set: Set(value),
  run callback: fn(value) -> a,
) -> Nil

from_list

</> 
pub fn from_list(values: List(value)) -> Set(value)

has

</> 
pub fn has(in set: Set(value), value value: value) -> Bool

intersection

</> 
pub fn intersection(
  of set: Set(value),
  and other: Set(value),
) -> Set(value)

Returns a new set containing values present in both sets.

is_disjoint_from

</> 
pub fn is_disjoint_from(
  set: Set(value),
  other: Set(value),
) -> Bool

is_subset_of

</> 
pub fn is_subset_of(set: Set(value), other: Set(value)) -> Bool

is_superset_of

</> 
pub fn is_superset_of(set: Set(value), other: Set(value)) -> Bool

new

</> 
pub fn new() -> Set(value)

size

</> 
pub fn size(of set: Set(value)) -> Int

symmetric_difference

</> 
pub fn symmetric_difference(
  of set: Set(value),
  and other: Set(value),
) -> Set(value)

Returns a new set containing values in either set but not both.

union

</> 
pub fn union(
  of set: Set(value),
  and other: Set(value),
) -> Set(value)

Returns a new set containing all values from both sets.

values

</> 
pub fn values(
  of set: Set(value),
) -> iterator.Iterator(value, Nil, Nil)
✨ Search Document