GArrowFile

GArrowFile — File interface

Functions

Types and Values

Object Hierarchy

    GInterface
    ╰── GArrowFile

Prerequisites

GArrowFile requires GObject.

Known Implementations

GArrowFile is implemented by GArrowBufferInputStream, GArrowBufferOutputStream, GArrowCUDABufferInputStream, GArrowCUDABufferOutputStream, GArrowCompressedInputStream, GArrowCompressedOutputStream, GArrowFileInputStream, GArrowFileOutputStream, GArrowGIOInputStream, GArrowGIOOutputStream, GArrowInputStream, GArrowMemoryMappedInputStream, GArrowOutputStream and GArrowSeekableInputStream.

Description

GArrowFile is an interface for file.

Functions

garrow_file_close ()

gboolean
garrow_file_close (GArrowFile *file,
                   GError **error);

Parameters

file

A GArrowFile.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.


garrow_file_is_closed ()

gboolean
garrow_file_is_closed (GArrowFile *file);

Parameters

file

A GArrowFile.

 

Returns

TRUE if the file is already closed, FALSE otherwise.

Since: 0.13.0


garrow_file_tell ()

gint64
garrow_file_tell (GArrowFile *file,
                  GError **error);

Parameters

file

A GArrowFile.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The current offset on success, -1 if there was an error.


garrow_file_get_mode ()

GArrowFileMode
garrow_file_get_mode (GArrowFile *file);

Parameters

file

A GArrowFile.

 

Returns

The mode of the file.

Types and Values

GARROW_TYPE_FILE

#define GARROW_TYPE_FILE (garrow_file_get_type())

GArrowFile

typedef struct _GArrowFile GArrowFile;

GArrowFileInterface

typedef struct _GArrowFileInterface GArrowFileInterface;