From 50cbd99857a674f2b082f5c436b7e721d33f4cd0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= <egil@erlang.org>
Date: Sun, 16 Mar 2014 23:32:44 +0100
Subject: erts: Document map guard functions

* erlang:is_map/1
* erlang:map_size/1
---
 erts/doc/src/erlang.xml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'erts/doc')

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index aeded7c719..e34646eaf0 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -1783,6 +1783,15 @@ os_prompt% </pre>
         <p>Allowed in guard tests.</p>
       </desc>
     </func>
+    <func>
+      <name name="is_map" arity="1"/>
+      <fsummary>Check whether a term is a map</fsummary>
+      <desc>
+        <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a map;
+          otherwise returns <c>false</c>.</p>
+        <p>Allowed in guard tests.</p>
+      </desc>
+    </func>
     <func>
       <name name="is_number" arity="1"/>
       <fsummary>Check whether a term is a number</fsummary>
@@ -2219,6 +2228,17 @@ os_prompt% </pre>
 {{[],aa,[],[],zz}</pre>
       </desc>
     </func>
+    <func>
+      <name name="map_size" arity="1"/>
+      <fsummary>Return the size of a map</fsummary>
+      <desc>
+        <p>Returns an integer which is the number of key-value pairs in <c><anno>Map</anno></c>.</p>
+        <pre>
+> <input>map_size(#{a=>1, b=>2, c=>3}).</input>
+3</pre>
+        <p>Allowed in guard tests.</p>
+      </desc>
+    </func>
     <func>
       <name name="max" arity="2"/>
       <fsummary>Return the largest of two term</fsummary>
-- 
cgit v1.2.3