From 25586f6e996f3c05277beb10a1dcc74e6be96cc7 Mon Sep 17 00:00:00 2001 From: Lexi Winter Date: Sat, 29 Mar 2025 04:13:48 +0000 Subject: nvxx.3: document the NUL restriction --- libnvxx/nvxx.3 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libnvxx/nvxx.3 b/libnvxx/nvxx.3 index a5b1a43..4cdfea4 100644 --- a/libnvxx/nvxx.3 +++ b/libnvxx/nvxx.3 @@ -432,6 +432,12 @@ exception. The .Va nv_error_state::error member variable may then be used to determine which specific error occurred. +.Sh KEY AND VALUE STRING RESTRICTIONS +The underlying C library does not support keys or string values that contain +the ASCII NUL character. +Any attempt to add a string value containing a NUL character, or any value +with a key containing a NUL character, will throw an exception of type +.Vt std::runtime_error . .Sh THE NV_FD TYPE The C++ library uses a type called .Vt bsd::nv_fd -- cgit v1.2.3