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

GDataInputStream: Clarify read_line() docs, mark as byte array

Browse Source 
g_data_input_stream_read_line() and
g_data_input_stream_read_line_finish() don't do any encoding checks,
so we shouldn't call the returned value a "string" (which I'd like to
mean UTF-8).  Annotate them as byte arrays and add encoding warnings
to the docstrings.

https://bugzilla.gnome.org/show_bug.cgi?id=652758
This commit is contained in:
Colin Walters 2011-06-16 13:14:44 -04:00
parent de0519581a
commit ff2f46a7f4
1 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
gio/gdatainputstream.c
View File

@ -734,17 +734,20 @@ scan_for_newline (GDataInputStream *stream,
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a line from the data input stream. * Reads a line from the data input stream. Note that no encoding
* checks or conversion is performed; the input is not guaranteed to
* be UTF-8, and may in fact have embedded NUL characters.
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* Returns: (transfer full): a string with the line that was read in * Returns: (transfer full) (array zero-terminated=1) (element-type guint8): a
* (without the newlines). Set @length to a #gsize to get the * NUL terminated byte array with the line that was read in (without
* length of the read line. On an error, it will return %NULL and * the newlines). Set @length to a #gsize to get the length of the
* @error will be set. If there's no content to read, it will * read line. On an error, it will return %NULL and @error will be
* still return %NULL, but @error won't be set. * set. If there's no content to read, it will still return %NULL,
* but @error won't be set.
**/ **/
char * char *
g_data_input_stream_read_line (GDataInputStream *stream, g_data_input_stream_read_line (GDataInputStream *stream,
@ -1182,9 +1185,12 @@ g_data_input_stream_read_until_async (GDataInputStream *stream,
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Finish an asynchronous call started by * Finish an asynchronous call started by
* g_data_input_stream_read_line_async(). * g_data_input_stream_read_line_async(). Note the warning about
* string encoding in g_data_input_stream_read_line() applies here as
* well.
* *
* Returns: (transfer full): a string with the line that was read in * Returns: (transfer full) (array zero-terminated=1) (element-type guint8): a
* NUL-terminated byte array with the line that was read in
* (without the newlines). Set @length to a #gsize to get the * (without the newlines). Set @length to a #gsize to get the
* length of the read line. On an error, it will return %NULL and * length of the read line. On an error, it will return %NULL and
* @error will be set. If there's no content to read, it will * @error will be set. If there's no content to read, it will