Add Belt.Set.getOrThrow and Belt.MutableSet.getOrThrow

mediremi · mediremi · commit f1e4a1ef54dd · 2025-06-29T15:36:23.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -51,6 +51,8 @@
   - `Belt.Array.setExn` → `Belt.Array.setOrThrow`
   - `Belt.Map.getExn` → `Belt.Map.getOrThrow`
   - `Belt.MutableMap.getExn` → `Belt.MutableMap.getOrThrow`
+  - `Belt.Set.getExn` → `Belt.Set.getOrThrow`
+  - `Belt.MutableSet.getExn` → `Belt.MutableSet.getOrThrow`
   - Old functions remain available but are marked as deprecated with guidance to use the new `OrThrow` variants.
   - https://github.com/rescript-lang/rescript/pull/7518, https://github.com/rescript-lang/rescript/pull/7554, https://github.com/rescript-lang/rescript/pull/7581
 
diff --git a/analysis/reanalyze/src/ExnLib.ml b/analysis/reanalyze/src/ExnLib.ml
@@ -15,10 +15,10 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   let beltMap = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let beltMutableMap = beltMap in
   let beltMutableQueue = [("peekExn", [notFound]); ("popExn", [notFound])] in
-  let beltMutableSet = [("getExn", [notFound])] in
+  let beltSet = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
+  let beltMutableSet = beltSet in
   let beltOption = [("getExn", [notFound])] in
   let beltResult = [("getExn", [notFound])] in
-  let beltSet = [("getExn", [notFound])] in
   let bsJson =
     (* bs-json *)
     [
diff --git a/lib/es6/Belt_MutableSet.js b/lib/es6/Belt_MutableSet.js
@@ -276,8 +276,8 @@ function getUndefined(d, x) {
   return Belt_internalAVLset.getUndefined(d.data, x, d.cmp);
 }
 
-function getExn(d, x) {
-  return Belt_internalAVLset.getExn(d.data, x, d.cmp);
+function getOrThrow(d, x) {
+  return Belt_internalAVLset.getOrThrow(d.data, x, d.cmp);
 }
 
 function split(d, key) {
@@ -477,6 +477,8 @@ let keepU = keep;
 
 let partitionU = partition;
 
+let getExn = getOrThrow;
+
 export {
   Int,
   $$String,
@@ -520,6 +522,7 @@ export {
   get,
   getUndefined,
   getExn,
+  getOrThrow,
   split,
   checkInvariantInternal,
 }
diff --git a/lib/es6/Belt_SetDict.js b/lib/es6/Belt_SetDict.js
@@ -314,7 +314,9 @@ let get = Belt_internalAVLset.get;
 
 let getUndefined = Belt_internalAVLset.getUndefined;
 
-let getExn = Belt_internalAVLset.getExn;
+let getExn = Belt_internalAVLset.getOrThrow;
+
+let getOrThrow = Belt_internalAVLset.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLset.checkInvariantInternal;
 
@@ -356,6 +358,7 @@ export {
   get,
   getUndefined,
   getExn,
+  getOrThrow,
   split,
   checkInvariantInternal,
 }
diff --git a/lib/es6/Belt_internalAVLset.js b/lib/es6/Belt_internalAVLset.js
@@ -688,7 +688,7 @@ function getUndefined(_n, x, cmp) {
   };
 }
 
-function getExn(_n, x, cmp) {
+function getOrThrow(_n, x, cmp) {
   while (true) {
     let n = _n;
     if (n !== undefined) {
@@ -877,7 +877,7 @@ export {
   subset,
   get,
   getUndefined,
-  getExn,
+  getOrThrow,
   fromArray,
   addMutate,
   balMutate,
diff --git a/lib/js/Belt_MutableSet.js b/lib/js/Belt_MutableSet.js
@@ -276,8 +276,8 @@ function getUndefined(d, x) {
   return Belt_internalAVLset.getUndefined(d.data, x, d.cmp);
 }
 
-function getExn(d, x) {
-  return Belt_internalAVLset.getExn(d.data, x, d.cmp);
+function getOrThrow(d, x) {
+  return Belt_internalAVLset.getOrThrow(d.data, x, d.cmp);
 }
 
 function split(d, key) {
@@ -477,6 +477,8 @@ let keepU = keep;
 
 let partitionU = partition;
 
+let getExn = getOrThrow;
+
 exports.Int = Int;
 exports.$$String = $$String;
 exports.make = make;
@@ -519,6 +521,7 @@ exports.maxUndefined = maxUndefined;
 exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.split = split;
 exports.checkInvariantInternal = checkInvariantInternal;
 /* No side effect */
diff --git a/lib/js/Belt_SetDict.js b/lib/js/Belt_SetDict.js
@@ -314,7 +314,9 @@ let get = Belt_internalAVLset.get;
 
 let getUndefined = Belt_internalAVLset.getUndefined;
 
-let getExn = Belt_internalAVLset.getExn;
+let getExn = Belt_internalAVLset.getOrThrow;
+
+let getOrThrow = Belt_internalAVLset.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLset.checkInvariantInternal;
 
@@ -355,6 +357,7 @@ exports.maxUndefined = maxUndefined;
 exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.split = split;
 exports.checkInvariantInternal = checkInvariantInternal;
 /* No side effect */
diff --git a/lib/js/Belt_internalAVLset.js b/lib/js/Belt_internalAVLset.js
@@ -688,7 +688,7 @@ function getUndefined(_n, x, cmp) {
   };
 }
 
-function getExn(_n, x, cmp) {
+function getOrThrow(_n, x, cmp) {
   while (true) {
     let n = _n;
     if (n !== undefined) {
@@ -876,7 +876,7 @@ exports.eq = eq;
 exports.subset = subset;
 exports.get = get;
 exports.getUndefined = getUndefined;
-exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.fromArray = fromArray;
 exports.addMutate = addMutate;
 exports.balMutate = balMutate;
diff --git a/runtime/Belt_MutableSet.res b/runtime/Belt_MutableSet.res
@@ -235,7 +235,9 @@ let get = (d, x) => N.get(~cmp=d.cmp, d.data, x)
 
 let getUndefined = (d, x) => N.getUndefined(~cmp=d.cmp, d.data, x)
 
-let getExn = (d, x) => N.getExn(~cmp=d.cmp, d.data, x)
+let getOrThrow = (d, x) => N.getOrThrow(~cmp=d.cmp, d.data, x)
+
+let getExn = getOrThrow
 
 let split = (d, key) => {
   let arr = N.toArray(d.data)
diff --git a/runtime/Belt_MutableSet.resi b/runtime/Belt_MutableSet.resi
@@ -637,8 +637,14 @@ let getUndefined: (t<'value, 'id>, 'value) => Js.undefined<'value>
 /**
 Same as `Belt.MutableSet.get` but raise when element does not exist.
 */
+@deprecated("Use `getOrThrow` instead")
 let getExn: (t<'value, 'id>, 'value) => 'value
 
+/**
+Same as `Belt.MutableSet.get` but raise when element does not exist.
+*/
+let getOrThrow: (t<'value, 'id>, 'value) => 'value
+
 /**
 Returns a tuple `((smaller, larger), present)`, `present` is true when element exist in set.
 
diff --git a/runtime/Belt_SetDict.res b/runtime/Belt_SetDict.res
@@ -251,7 +251,8 @@ let maximum = N.maximum
 let maxUndefined = N.maxUndefined
 let minUndefined = N.minUndefined
 let get = N.get
-let getExn = N.getExn
+let getOrThrow = N.getOrThrow
+let getExn = getOrThrow
 let getUndefined = N.getUndefined
 
 let fromSortedArrayUnsafe = N.fromSortedArrayUnsafe
diff --git a/runtime/Belt_SetDict.resi b/runtime/Belt_SetDict.resi
@@ -608,8 +608,14 @@ let getUndefined: (t<'value, 'id>, 'value, ~cmp: cmp<'value, 'id>) => Js.undefin
 /**
 Same as [get](#get) but raise when element does not exist.
 */
+@deprecated("Use `getOrThrow` instead")
 let getExn: (t<'value, 'id>, 'value, ~cmp: cmp<'value, 'id>) => 'value
 
+/**
+Same as [get](#get) but raise when element does not exist.
+*/
+let getOrThrow: (t<'value, 'id>, 'value, ~cmp: cmp<'value, 'id>) => 'value
+
 /**
 Returns a tuple `((smaller, larger), present)`, `present` is true when element exist in set.
 
diff --git a/runtime/Belt_internalAVLset.res b/runtime/Belt_internalAVLset.res
@@ -588,7 +588,7 @@ let rec getUndefined = (n: t<_>, x, ~cmp) =>
     }
   }
 
-let rec getExn = (n: t<_>, x, ~cmp) =>
+let rec getOrThrow = (n: t<_>, x, ~cmp) =>
   switch n {
   | None => throw(Not_found)
   | Some(t) /* Node(l, v, r, _) */ =>
@@ -597,7 +597,7 @@ let rec getExn = (n: t<_>, x, ~cmp) =>
     if c == 0 {
       v
     } else {
-      getExn(
+      getOrThrow(
         ~cmp,
         if c < 0 {
           t.left
diff --git a/runtime/Belt_internalAVLset.resi b/runtime/Belt_internalAVLset.resi
@@ -95,7 +95,7 @@ let eq: (t<'a>, t<'a>, ~cmp: cmp<'a, 'b>) => bool
 let subset: (t<'a>, t<'a>, ~cmp: cmp<'a, 'b>) => bool
 let get: (t<'a>, 'a, ~cmp: cmp<'a, 'b>) => option<'a>
 let getUndefined: (t<'a>, 'a, ~cmp: cmp<'a, 'b>) => Js.undefined<'a>
-let getExn: (t<'a>, 'a, ~cmp: cmp<'a, 'b>) => 'a
+let getOrThrow: (t<'a>, 'a, ~cmp: cmp<'a, 'b>) => 'a
 
 let fromArray: (array<'a>, ~cmp: cmp<'a, 'b>) => t<'a>
 
