File 0476-Clarify-when-bin-needs-to-be-released.patch of Package erlang
From deb0018eae36fecd75cc418b2e4a97b8ab967bdf Mon Sep 17 00:00:00 2001 From: Simon Cornish <7t9jna402@sneakemail.com> Date: Wed, 13 Aug 2025 16:29:01 -0700 Subject: [PATCH] Clarify when bin needs to be released When using enif_inspect_iolist_as_binary() or enif_inspect_binary() the resulting ErlNifBinary does need to be released before the return to Erlang if enif_realloc_binary() has been called on it. --- erts/doc/references/erl_nif.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/erts/doc/references/erl_nif.md b/erts/doc/references/erl_nif.md index b72f7d9b44..6f3e81aae3 100644 --- a/erts/doc/references/erl_nif.md +++ b/erts/doc/references/erl_nif.md @@ -1679,7 +1679,9 @@ int enif_inspect_binary( ``` Initializes the structure pointed to by `bin` with information about binary term -`bin_term`. +`bin_term`. The data pointed to by `bin` is transient and does not need to be +released unless it has been later reallocated with [`enif_realloc_binary` +](erl_nif.md#enif_realloc_binary). Returns `true` on success, or `false` if `bin_term` is not a binary. @@ -1694,7 +1696,8 @@ int enif_inspect_iolist_as_binary( Initializes the structure pointed to by `bin` with a continuous buffer with the same byte content as `iolist`. As with `inspect_binary`, the data pointed to by -`bin` is transient and does not need to be released. +`bin` is transient and does not need to be released unless it has been later +reallocated with [`enif_realloc_binary` ](erl_nif.md#enif_realloc_binary). Returns `true` on success, or `false` if `iolist` is not an iolist. -- 2.43.0
