Commit f2c77ee7 authored by Will Thompson's avatar Will Thompson

g_input_stream_read[_finish]: document returning 0 on EOF

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
parent 27d95bd8
......@@ -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,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment