diff options
| author | Sverker Eriksson <sverker@erlang.org> | 2020-06-29 13:30:54 +0200 |
|---|---|---|
| committer | Sverker Eriksson <sverker@erlang.org> | 2020-06-30 13:32:31 +0200 |
| commit | c1466e9dae9663d6fe06291f4b2e458b524f874f (patch) | |
| tree | 8bf31ace2a15b6724f2c88ebe8584dc7016e1b8b /lib/erl_interface | |
| parent | a46a702dd59fbae6768d79ca5a4544c96c0fe9fd (diff) | |
| download | erlang-c1466e9dae9663d6fe06291f4b2e458b524f874f.tar.gz | |
erl_interface: Document ei_get_type *size for bignums
Diffstat (limited to 'lib/erl_interface')
| -rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index a47b344c4c..9161279ef7 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -1020,8 +1020,10 @@ ei_encode_tuple_header(buf, &i, 0);</pre> size is the number of characters <em>not</em> including the terminating <c>NULL</c>. For binaries and bitstrings, <c>*size</c> is the number of bytes. For lists, tuples and maps, <c>*size</c> is the - arity of the object. For other types, <c>*size</c> is 0. In all - cases, <c>index</c> is left unchanged.</p> + arity of the object. For bignum integers, <c>*size</c> is + the number of bytes for the absolute value of the bignum. + For other types, <c>*size</c> is 0. + In all cases, <c>index</c> is left unchanged.</p> <p>Currently <c>*type</c> is one of:</p> <taglist> <tag>ERL_ATOM_EXT</tag> |