aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2019-02-13 08:29:51 +0100
committerBjörn Gustavsson <[email protected]>2019-02-14 06:52:26 +0100
commit0ab6149067a82d89e584f862604c1c63578fd5fa (patch)
tree32c887276074c1aa758fe655fab8219427e1e81a /erts/doc/src
parent485713afa0d2481e93882bc386aebb06a49c04bc (diff)
downloadotp-0ab6149067a82d89e584f862604c1c63578fd5fa.tar.gz
otp-0ab6149067a82d89e584f862604c1c63578fd5fa.tar.bz2
otp-0ab6149067a82d89e584f862604c1c63578fd5fa.zip
Add persistent_term:get(Key, DefaultValue)
https://bugs.erlang.org/browse/ERL-843
Diffstat (limited to 'erts/doc/src')
-rw-r--r--erts/doc/src/persistent_term.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/erts/doc/src/persistent_term.xml b/erts/doc/src/persistent_term.xml
index 1eda7f8d76..9d3c9afd80 100644
--- a/erts/doc/src/persistent_term.xml
+++ b/erts/doc/src/persistent_term.xml
@@ -256,6 +256,22 @@ will be slower as the number of persistent terms increases.</pre>
</func>
<func>
+ <name name="get" arity="2" since="OTP 21.3"/>
+ <fsummary>Get the value for a persistent term.</fsummary>
+ <desc>
+ <p>Retrieve the value for the persistent term associated with
+ the key <c><anno>Key</anno></c>. The lookup will be made in
+ constant time and the value will not be copied to the heap
+ of the calling process.</p>
+ <p>This function returns <c><anno>Default</anno></c> if no
+ term has been stored with the key <c><anno>Key</anno></c>.</p>
+ <p>If the calling process holds on to the value of the
+ persistent term and the persistent term is deleted in the future,
+ the term will be copied to the process.</p>
+ </desc>
+ </func>
+
+ <func>
<name name="info" arity="0" since="OTP 21.2"/>
<fsummary>Get information about persistent terms.</fsummary>
<desc>