GArrowIPCStreamWriter

GArrowIPCStreamWriter — Stream writer class

Functions

Properties

gpointer stream-writer Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowIPCStreamWriter
        ╰── GArrowIPCFileWriter

Description

GArrowIPCStreamWriter is a class for sending data by stream based IPC.

Functions

garrow_ipc_stream_writer_open ()

GArrowIPCStreamWriter *
garrow_ipc_stream_writer_open (GArrowIOOutputStream *sink,
                               GArrowSchema *schema,
                               GError **error);

Parameters

sink

The output of the writer.

 

schema

The schema of the writer.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly opened GArrowIPCStreamWriter or NULL on error.

[nullable][transfer full]


garrow_ipc_stream_writer_write_record_batch ()

gboolean
garrow_ipc_stream_writer_write_record_batch
                               (GArrowIPCStreamWriter *stream_writer,
                                GArrowRecordBatch *record_batch,
                                GError **error);

Parameters

stream_writer

A GArrowIPCStreamWriter.

 

record_batch

The record batch to be written.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.


garrow_ipc_stream_writer_close ()

gboolean
garrow_ipc_stream_writer_close (GArrowIPCStreamWriter *stream_writer,
                                GError **error);

Parameters

stream_writer

A GArrowIPCStreamWriter.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.

Types and Values

struct GArrowIPCStreamWriter

struct GArrowIPCStreamWriter;

It wraps arrow::ipc::StreamWriter.


struct GArrowIPCStreamWriterClass

struct GArrowIPCStreamWriterClass {
  GObjectClass parent_class;
};

Property Details

The “stream-writer” property

  “stream-writer”            gpointer

The raw std::shared<arrow::ipc::StreamWriter> *.

Flags: Write / Construct Only