diff options
| author | Lexi Winter <lexi@hemlock.eden.le-fay.org> | 2025-03-29 04:13:48 +0000 |
|---|---|---|
| committer | Lexi Winter <lexi@hemlock.eden.le-fay.org> | 2025-03-29 04:13:48 +0000 |
| commit | 25586f6e996f3c05277beb10a1dcc74e6be96cc7 (patch) | |
| tree | 4bb85196ecd3c03ef263b538c985ddedb805f046 | |
| parent | c114065f84f085ca0f8944eb0c7f337bbdf4b788 (diff) | |
| download | libnvxx-25586f6e996f3c05277beb10a1dcc74e6be96cc7.tar.gz libnvxx-25586f6e996f3c05277beb10a1dcc74e6be96cc7.tar.bz2 | |
nvxx.3: document the NUL restriction
| -rw-r--r-- | libnvxx/nvxx.3 | 6 |
1 files changed, 6 insertions, 0 deletions
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 |