GArrowWritable: Apache Arrow GLib Reference Manual

GArrowWritable

GArrowWritable — Output interface

Functions

gboolean	garrow_writable_write ()
gboolean	garrow_writable_flush ()

Types and Values

#define	GARROW_TYPE_WRITABLE
	GArrowWritable
	GArrowWritableInterface

Object Hierarchy

    GInterface
    ╰── GArrowWritable

Prerequisites

GArrowWritable requires GObject.

Known Implementations

GArrowWritable is implemented by GArrowBufferOutputStream, GArrowCompressedOutputStream, GArrowFileOutputStream, GArrowGIOOutputStream and GArrowOutputStream.

Description

GArrowWritable is an interface for output. Output must be writable.

Functions

garrow_writable_write ()

gboolean
garrow_writable_write (GArrowWritable *writable,
                       const guint8 *data,
                       gint64 n_bytes,
                       GError **error);

Parameters

writable	A GArrowWritable.
data	The data to be written.	[array length=n_bytes]
n_bytes	The number of bytes to be written.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE if there was an error.

garrow_writable_flush ()

gboolean
garrow_writable_flush (GArrowWritable *writable,
                       GError **error);

It ensures writing all data on memory to storage.

Parameters

writable	A GArrowWritable.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE if there was an error.

Types and Values

GARROW_TYPE_WRITABLE

#define GARROW_TYPE_WRITABLE (garrow_writable_get_type())

GArrowWritable

typedef struct _GArrowWritable GArrowWritable;

GArrowWritableInterface

typedef struct _GArrowWritableInterface GArrowWritableInterface;