From 1b2cea397131a36a39b18c6ce8c6944bf11db4c7 Mon Sep 17 00:00:00 2001
From: Filipe David Manana <fdmanana@apache.org>
Date: Mon, 16 May 2011 17:00:25 +0100
Subject: Add erlang:external_size/2 BIF

This BIF's second parameter is a list of options.
Currently the only allowed option is {minor_version, Version}
where version is either 0 (default) or 1.
---
 erts/doc/src/erlang.xml | 50 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

(limited to 'erts/doc/src')

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index ad7a57bd73..84d4160e6a 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -1034,6 +1034,56 @@ b</pre>
           exit reason <c>killed</c>.</p>
       </desc>
     </func>
+    <func>
+      <name>erlang:external_size(Term) -> integer() >= 0</name>
+      <fsummary>Calculate the maximum size for a term encoded in the Erlang
+        external term format</fsummary>
+      <type>
+        <v>Term = term()</v>
+      </type>
+      <desc>
+        <p>Calculates, without doing the encoding, the maximum byte size for
+          a term encoded in the Erlang external term format. The following
+          condition applies always:</p>
+        <p>
+          <pre>
+> <input>Size1 = byte_size(term_to_binary(Term)),</input>
+> <input>Size2 = erlang:external_size(Term),</input>
+> <input>true = Size1 =&lt; Size2.</input>
+true
+          </pre>
+        </p>
+        <p>This is equivalent to a call to: <code>erlang:external_size(Term, [])
+          </code></p>
+      </desc>
+    </func>
+    <func>
+      <name>erlang:external_size(Term, [Option]) -> integer() >= 0</name>
+      <fsummary>Calculate the maximum size for a term encoded in the Erlang
+        external term format</fsummary>
+      <type>
+        <v>Term = term()</v>
+        <v>Option = {minor_version, Version}</v>
+      </type>
+      <desc>
+        <p>Calculates, without doing the encoding, the maximum byte size for
+          a term encoded in the Erlang external term format. The following
+          condition applies always:</p>
+        <p>
+          <pre>
+> <input>Size1 = byte_size(term_to_binary(Term, Options)),</input>
+> <input>Size2 = erlang:external_size(Term, Options),</input>
+> <input>true = Size1 =&lt; Size2.</input>
+true
+          </pre>
+        </p>
+        <p>The option <c>{minor_version, Version}</c> specifies how floats
+          are encoded. See
+          <seealso marker="#term_to_binary/2">term_to_binary/2</seealso> for
+          a more detailed description.
+        </p>
+      </desc>
+    </func>
     <func>
       <name>float(Number) -> float()</name>
       <fsummary>Convert a number to a float</fsummary>
-- 
cgit v1.2.3