Output stream classes

Output stream classes

Functions

Properties

gpointer output-stream Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ├── GArrowOutputStream
       ├── GArrowBufferOutputStream
       ├── GArrowFileOutputStream
       ╰── GArrowGIOOutputStream
    ╰── GArrowOutputStream
        ├── GArrowBufferOutputStream
        ├── GArrowFileOutputStream
        ╰── GArrowGIOOutputStream

Implemented Interfaces

GArrowOutputStream implements

GArrowFileOutputStream implements

GArrowBufferOutputStream implements

GArrowGIOOutputStream implements

Includes

#include <arrow-glib/arrow-glib.h>

Description

GArrowOutputStream is an interface for stream output. Stream output is file based and writeable

GArrowFileOutputStream is a class for file output stream.

GArrowBufferOutputStream is a class for buffer output stream.

GArrowGIOOutputStream is a class for GOutputStream based output stream.

Functions

garrow_output_stream_write_tensor ()

gint64
garrow_output_stream_write_tensor (GArrowOutputStream *stream,
                                   GArrowTensor *tensor,
                                   GError **error);

Parameters

stream

A GArrowWriteable.

 

tensor

A GArrowTensor to be written.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The number of written bytes on success, -1 on error.

Since 0.4.0


garrow_file_output_stream_new ()

GArrowFileOutputStream *
garrow_file_output_stream_new (const gchar *path,
                               gboolean append,
                               GError **error);

Parameters

path

The path of the file output stream.

 

append

Whether the path is opened as append mode or recreate mode.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A newly opened GArrowFileOutputStream or NULL on error.

[nullable]


garrow_buffer_output_stream_new ()

GArrowBufferOutputStream *
garrow_buffer_output_stream_new (GArrowResizableBuffer *buffer);

Parameters

buffer

The resizable buffer to be output.

 

Returns

A newly created GArrowBufferOutputStream.

[transfer full]


garrow_gio_output_stream_new ()

GArrowGIOOutputStream *
garrow_gio_output_stream_new (GOutputStream *gio_output_stream);

Parameters

gio_output_stream

The stream to be output.

 

Returns

A newly created GArrowGIOOutputStream.

[transfer full]


garrow_gio_output_stream_get_raw ()

GOutputStream *
garrow_gio_output_stream_get_raw (GArrowGIOOutputStream *output_stream);

Parameters

output_stream

A GArrowGIOOutputStream.

 

Returns

The wrapped GOutputStream.

[transfer none]

Since 0.5.0

Types and Values

struct GArrowOutputStream

struct GArrowOutputStream;

It wraps arrow::io::OutputStream.


struct GArrowFileOutputStream

struct GArrowFileOutputStream;

It wraps arrow::io::FileOutputStream.


struct GArrowBufferOutputStream

struct GArrowBufferOutputStream;

It wraps arrow::io::BufferOutputStream.


struct GArrowGIOOutputStream

struct GArrowGIOOutputStream;

It's an output stream for GOutputStream.

Property Details

The “output-stream” property

  “output-stream”            gpointer

The raw std::shared<arrow::io::OutputStream> *.

Flags: Write / Construct Only