GInputStream

GInputStream — Base class for implementing streaming input

Functions

gssize g_input_stream_read ()
gboolean g_input_stream_read_all ()
void g_input_stream_read_all_async ()
gboolean g_input_stream_read_all_finish ()
gssize g_input_stream_skip ()
gboolean g_input_stream_close ()
void g_input_stream_read_async ()
gssize g_input_stream_read_finish ()
void g_input_stream_skip_async ()
gssize g_input_stream_skip_finish ()
void g_input_stream_close_async ()
gboolean g_input_stream_close_finish ()
gboolean g_input_stream_is_closed ()
gboolean g_input_stream_has_pending ()
gboolean g_input_stream_set_pending ()
void g_input_stream_clear_pending ()
GBytes * g_input_stream_read_bytes ()
void g_input_stream_read_bytes_async ()
GBytes * g_input_stream_read_bytes_finish ()

Types and Values

  GInputStream

Object Hierarchy

    GObject
    ╰── GInputStream
        ├── GFilterInputStream
        ├── GFileInputStream
        ├── GMemoryInputStream
        ╰── GUnixInputStream

Known Derived Interfaces

GInputStream is required by GPollableInputStream.

Includes

#include <gio/gio.h>

Description

GInputStream has functions to read from a stream (g_input_stream_read()), to close a stream (g_input_stream_close()) and to skip some content (g_input_stream_skip()).

To copy the content of an input stream to an output stream without manually handling the reads and writes, use g_output_stream_splice().

See the documentation for GIOStream for details of thread safety of streaming APIs.

All of these functions have async variants too.

Functions

g_input_stream_read ()

gssize
g_input_stream_read (GInputStream *stream,
                     void *buffer,
                     gsize count,
                     GCancellable *cancellable,
                     GError **error);

Tries to read count bytes from the stream into the buffer starting at buffer . Will block during this read.

If count is zero returns zero and does nothing. A value of count larger than G_MAXSSIZE will cause a G_IO_ERROR_INVALID_ARGUMENT error.

On success, the number of bytes read into the buffer is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file. Zero is returned on end of file (or if count is zero), but never otherwise.

The returned buffer is not a nul-terminated string, it can contain nul bytes at any position, and this function doesn't nul-terminate the buffer .

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

On error -1 is returned and error is set accordingly.

Parameters

stream

a GInputStream.

  

buffer

a buffer to read data into (which should be at least count bytes long).

[array length=count][element-type guint8][out caller-allocates]