GArrowReadable: Apache Arrow GLib Reference Manual

GArrowReadable

GArrowReadable — Input interface

Functions

GArrowBuffer *	garrow_readable_read ()
GBytes *	garrow_readable_read_bytes ()

Types and Values

#define	GARROW_TYPE_READABLE
	GArrowReadable
	GArrowReadableInterface

Object Hierarchy

    GInterface
    ╰── GArrowReadable

Prerequisites

GArrowReadable requires GObject.

Known Implementations

GArrowReadable is implemented by GArrowBufferInputStream, GArrowCUDABufferInputStream, GArrowCompressedInputStream, GArrowGIOInputStream, GArrowInputStream, GArrowMemoryMappedInputStream and GArrowSeekableInputStream.

Description

GArrowReadable is an interface for input. Input must be readable.

Functions

garrow_readable_read ()

GArrowBuffer *
garrow_readable_read (GArrowReadable *readable,
                      gint64 n_bytes,
                      GError **error);

Parameters

readable	A GArrowReadable.
n_bytes	The number of bytes to be read.
error	Return location for a GError or `NULL`.	[nullable]

Returns

GArrowBuffer that has read data on success, NULL if there was an error.

[transfer full][nullable]

garrow_readable_read_bytes ()

GBytes *
garrow_readable_read_bytes (GArrowReadable *readable,
                            gint64 n_bytes,
                            GError **error);

Parameters

readable	A GArrowReadable.
n_bytes	The number of bytes to be read.
error	Return location for a GError or `NULL`.	[nullable]

Returns

GBytes that has read data on success, NULL if there was an error.

[transfer full][nullable]

Since: 0.17.0

Types and Values

GARROW_TYPE_READABLE

#define GARROW_TYPE_READABLE (garrow_readable_get_type())

GArrowReadable

typedef struct _GArrowReadable GArrowReadable;

GArrowReadableInterface

typedef struct _GArrowReadableInterface GArrowReadableInterface;