torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

make read_file_to_str_until_eof doc more explicit

Browse Source 
the sz_out param is set to what was read (i.e not including the final
NULL the function adds for convenience), but could be understood to
be set to what was read+1 (including the NULL terminator)
This commit is contained in:
trinity-1686a
2024-02-18 12:37:59 +01:00
parent b0b943a161
commit e913de1bc6
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/fs/files.c
+4 -3
View File
@@ -572,9 +572,10 @@ write_bytes_to_new_file(const char *fname, const char *str, size_t len,
/**
* Read the contents of the open file <b>fd</b> presuming it is a FIFO
* (or similar) file descriptor for which the size of the file isn't
* known ahead of time. Return NULL on failure, and a NUL-terminated
* string on success. On success, set <b>sz_out</b> to the number of
* bytes read.
* known ahead of time.
* Return NULL on failure, and a NUL-terminated string on success.
* On success, set <b>sz_out</b> to the number of bytes read (not including
* the final NULL, which wasn't read from <b>fd</fd>).
*/
char *
read_file_to_str_until_eof(int fd, size_t max_bytes_to_read, size_t *sz_out)