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

docs: explain inconsistency of _{read,write}_all()

Browse Source 
These functions are inconsistent with our normal conventions in that
they set an output variable to a specified value, even in the case that
an error is thrown.

Document very clearly that this should be considered exceptional.

https://bugzilla.gnome.org/show_bug.cgi?id=737451
This commit is contained in:
Ryan Lortie 2014-09-29 11:50:05 -04:00
parent c8d1047093
commit 223b5f757f
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
gio/ginputstream.c
View File

@ -223,8 +223,14 @@ g_input_stream_read (GInputStream *stream,
* read into @buffer. * read into @buffer.
* *
* If there is an error during the operation %FALSE is returned and @error * If there is an error during the operation %FALSE is returned and @error
* is set to indicate the error status, @bytes_read is updated to contain * is set to indicate the error status.
* the number of bytes read into @buffer before the error occurred. *
* As a special exception to the normal conventions for functions that
* use #GError, if this function returns %FALSE (and sets @error) then
* @bytes_read will be set to the number of bytes that were successfully
* read before the error was encountered. This functionality is only
* available from C. If you need it from another language then you must
* write your own loop around g_input_stream_read().
* *
* Returns: %TRUE on success, %FALSE if there was an error * Returns: %TRUE on success, %FALSE if there was an error
**/ **/

11
gio/goutputstream.c
View File

@ -246,8 +246,15 @@ g_output_stream_write (GOutputStream *stream,
* is set to @count. * is set to @count.
* *
* If there is an error during the operation %FALSE is returned and @error * If there is an error during the operation %FALSE is returned and @error
* is set to indicate the error status, @bytes_written is updated to contain * is set to indicate the error status.
* the number of bytes written into the stream before the error occurred. *
* As a special exception to the normal conventions for functions that
* use #GError, if this function returns %FALSE (and sets @error) then
* @bytes_written will be set to the number of bytes that were
* successfully written before the error was encountered. This
* functionality is only available from C. If you need it from another
* language then you must write your own loop around
* g_output_stream_write().
* *
* Returns: %TRUE on success, %FALSE if there was an error * Returns: %TRUE on success, %FALSE if there was an error
**/ **/