fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-28 14:30:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

glib-aux/trivial: add code comment to nm_str_buf_get_str_unsafe()

Browse source
This commit is contained in:
Thomas Haller 2022-04-13 09:15:24 +02:00
parent 2c5bacd416
commit 24dab91a66
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/libnm-glib-aux/nm-str-buf.h
View file

@ -399,6 +399,29 @@ nm_str_buf_get_str(NMStrBuf *strbuf)
return strbuf->_priv_str;
}
/**
* nm_str_buf_get_str_unsafe:
* @strbuf: the buffer
*
* Usually, NMStrBuf is used to construct NUL terminated strings. But
* while constructing the buffer (nm_str_buf_append*()), it does
* not NUL terminate the buffer yet. Only nm_str_buf_get_str()
* and nm_str_buf_finalize() ensure that the returned string is
* actually NUL terminated.
*
* NMStrBuf can also be used for binary data, or you might not
* require the NUL termination. In that case, nm_str_buf_get_str_unsafe()
* will give you the pointer, but you must not rely on it being NUL
* terminated. This is the "unsafe" part of it.
*
* The returned string is of course initialized up to length "strbuf->len"
* and allocated with "strbuf->allocated" bytes.
*
* If currently no buffer is allocated, %NULL is returned.
*
* Returns: (transfer none): very similar to nm_str_buf_get_str(),
* except that the result is no guaranteed to be NUL terminated.
*/
static inline char *
nm_str_buf_get_str_unsafe(NMStrBuf *strbuf)
{