From 10fe8c806575b4e869420dfbfb8d23a801fdb740 Mon Sep 17 00:00:00 2001 From: Bartosz Sosnowski Date: Mon, 19 Feb 2018 18:04:41 +0100 Subject: [PATCH] doc: add note about handle movability Add note that explaining pointers to handles need to remain valid during the requested operations. Refs: https://github.com/libuv/libuv/issues/1731 PR-URL: https://github.com/libuv/libuv/pull/1749 Reviewed-By: Colin Ihrig Reviewed-By: Santiago Gimeno --- docs/src/handle.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/handle.rst b/docs/src/handle.rst index e4cb90b5..cdfb76bf 100644 --- a/docs/src/handle.rst +++ b/docs/src/handle.rst @@ -9,6 +9,9 @@ Structures are aligned so that any libuv handle can be cast to `uv_handle_t`. All API functions defined here work with any handle type. +Libuv handles are not movable. Pointers to handle structures passed to +functions must remain valid for the duration of the requested operation. Take +care when using stack allocated handles. Data types ----------