Camel Reference Manual: CamelStream

CamelStream

Functions

gssize	camel_stream_read ()
gssize	camel_stream_write ()
gint	camel_stream_flush ()
gint	camel_stream_close ()
gboolean	camel_stream_eos ()
gssize	camel_stream_write_string ()
gssize	camel_stream_write_to_stream ()

Types and Values

struct

CamelStream

Object Hierarchy

    GObject
    ╰── CamelObject
        ╰── CamelStream
            ├── CamelIMAPXStream
            ├── CamelStreamBuffer
            ├── CamelStreamFilter
            ├── CamelStreamFs
            ├── CamelStreamMem
            ├── CamelStreamNull
            ├── CamelStreamProcess
            ├── CamelStreamVFS
            ╰── CamelTcpStream

Description

Functions

camel_stream_read ()

gssize
camel_stream_read (CamelStream *stream,
                   gchar *buffer,
                   gsize n,
                   GCancellable *cancellable,
                   GError **error);

Attempts to read up to len bytes from stream into buf .

Parameters

stream	a CamelStream object.
buffer	output buffer
n	max number of bytes to read.
cancellable	optional GCancellable object, or `NULL`
error	return location for a GError, or `NULL`

Returns

the number of bytes actually read, or -1 on error and set errno.

camel_stream_write ()

gssize
camel_stream_write (CamelStream *stream,
                    const gchar *buffer,
                    gsize n,
                    GCancellable *cancellable,
                    GError **error);

Attempts to write up to n bytes of buffer into stream .

Parameters

stream	a CamelStream object
buffer	buffer to write.
n	number of bytes to write
cancellable	optional GCancellable object, or `NULL`
error	return location for a GError, or `NULL`

Returns

the number of bytes written to the stream, or -1 on error along with setting errno.

camel_stream_flush ()

gint
camel_stream_flush (CamelStream *stream,
                    GCancellable *cancellable,
                    GError **error);

Flushes any buffered data to the stream's backing store. Only meaningful for writable streams.

Parameters

stream	a CamelStream object
cancellable	optional GCancellable object, or `NULL`
error	return location for a GError, or `NULL`

Returns

0 on success or -1 on fail along with setting error

camel_stream_close ()

gint
camel_stream_close (CamelStream *stream,
                    GCancellable *cancellable,
                    GError **error);

Closes the stream.

Parameters

stream	a CamelStream object
cancellable	optional GCancellable object, or `NULL`
error	return location for a GError, or `NULL`

Returns

0 on success or -1 on error.

camel_stream_eos ()

gboolean
camel_stream_eos (CamelStream *stream);

Tests if there are bytes left to read on the stream object.

Parameters

stream

a CamelStream object

Returns

TRUE on EOS or FALSE otherwise.

camel_stream_write_string ()

gssize
camel_stream_write_string (CamelStream *stream,
                           const gchar *string,
                           GCancellable *cancellable,
                           GError **error);

Writes the string to the stream.

Parameters

stream	a CamelStream object
string	a string
error	return location for a GError, or `NULL`

Returns

the number of characters written or -1 on error.

camel_stream_write_to_stream ()

gssize
camel_stream_write_to_stream (CamelStream *stream,
                              CamelStream *output_stream,
                              GCancellable *cancellable,
                              GError **error);

Write all of a stream (until eos) into another stream, in a blocking fashion.

Parameters

stream	source CamelStream object
output_stream	destination CamelStream object
cancellable	optional GCancellable object, or `NULL`
error	return location for a GError, or `NULL`

Returns

-1 on error, or the number of bytes succesfully copied across streams.

Types and Values

struct CamelStream

struct CamelStream;