ETS: Allow for matchspec-based replacement

1 files changed, 21 insertions, 0 deletions

diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml
index 05401a2d40..36c803b40c 100644
--- a/lib/stdlib/doc/src/ets.xml
+++ b/lib/stdlib/doc/src/ets.xml
@@ -1491,6 +1491,27 @@ is_integer(X), is_integer(Y), X + Y < 4711]]></code>
     </func>
 
     <func>
+      <name name="select_replace" arity="2"/>
+      <fsummary>Match the objects in an ETS table against a match_spec and
+        replaces matching objects with the match_spec result</fsummary>
+      <desc>
+        <p>Matches the objects in the table <c><anno>Tab</anno></c> using a
+          <seealso marker="#match_spec">match_spec</seealso>. If the
+          an object is matched, and the match_spec result is an object with the
+          same key, the existing object is replaced with the match_spec result.
+          For any other result from the match_spec the object is kept
+          unchanged.</p>
+        <p>The function returns the number of objects actually
+          replaced in the table.</p>
+        <note>
+          <p>The <c>match_spec</c> has to return an object with the same key if
+            the object is to be replaced. No other return value will get the
+            object replaced.</p>
+        </note>
+      </desc>
+    </func>
+
+    <func>
       <name name="select_reverse" arity="1"/>
       <fsummary>Continue matching objects in an ETS table.</fsummary>
       <desc>