luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-24 13:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

g_input_stream_read[_finish]: document returning 0 on EOF

Browse Source 
g_input_stream_read() does state that it returns 0 on end of file, but
not in the Returns: line, so it's easy to miss on a quick skim-read.

g_input_stream_read_async() documents that g_input_stream_read_finish()
returns 0 on end of file, but g_input_stream_read_finish() itself does
not.

https://bugzilla.gnome.org/show_bug.cgi?id=673174
This commit is contained in:
Will Thompson 2012-03-30 14:44:05 +01:00
parent 27d95bd81f
commit f2c77ee718
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
gio/ginputstream.c
View File

@ -161,7 +161,7 @@ g_input_stream_init (GInputStream *stream)
*
* On error -1 is returned and @error is set accordingly.
*
* Return value: Number of bytes read, or -1 on error
* Return value: Number of bytes read, or -1 on error, or 0 on end of file.
**/
gssize
g_input_stream_read (GInputStream *stream,
@ -583,7 +583,7 @@ g_input_stream_read_async (GInputStream *stream,
*
* Finishes an asynchronous stream read operation.
*
* Returns: number of bytes read in, or -1 on error.
* Returns: number of bytes read in, or -1 on error, or 0 on end of file.
**/
gssize
g_input_stream_read_finish (GInputStream *stream,