Version related macros

Version related macros

Functions

Types and Values

Object Hierarchy


Includes

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

Description

Apache Arrow GLib provides macros that can be used by C pre-processor. They are useful to check version related things at compile time.

Functions

GARROW_VERSION_MAJOR

#define             GARROW_VERSION_MAJOR

The major version.

Since 0.10.0


GARROW_VERSION_MINOR

#define             GARROW_VERSION_MINOR

The minor version.

Since 0.10.0


GARROW_VERSION_MICRO

#define             GARROW_VERSION_MICRO

The micro version.

Since 0.10.0


GARROW_VERSION_CHECK()

#define             GARROW_VERSION_CHECK(major, minor, micro)

You can use this macro in C pre-processor.

Parameters

major

A major version to check for.

 

minor

A minor version to check for.

 

micro

A micro version to check for.

 

Returns

TRUE if the compile time Apache Arrow GLib version is the same as or newer than the passed version, FALSE otherwise.

Since 0.10.0


GARROW_DEPRECATED_FOR()

#define             GARROW_DEPRECATED_FOR(function)

GARROW_DEPRECATED_FOR is deprecated and should not be used in newly-written code.


GARROW_UNAVAILABLE()

#define             GARROW_UNAVAILABLE(major, minor)


GARROW_DEPRECATED_IN_0_10_FOR()

#define             GARROW_DEPRECATED_IN_0_10_FOR(function)

GARROW_DEPRECATED_IN_0_10_FOR is deprecated and should not be used in newly-written code.

Types and Values

GARROW_VERSION_TAG

#define             GARROW_VERSION_TAG

The version tag. Normally, it's an empty string. It's "SNAPSHOT" for snapshot version.

Since 0.10.0


GARROW_DEPRECATED

#define             GARROW_DEPRECATED

GARROW_DEPRECATED is deprecated and should not be used in newly-written code.


GARROW_VERSION_0_10

#define             GARROW_VERSION_0_10

You can use this macro value for compile time API version check.

Since 0.10.0


GARROW_VERSION_MIN_REQUIRED

#define             GARROW_VERSION_MIN_REQUIRED

You can use this macro for compile time API version check.

This macro value must be one of the predefined version macros such as GARROW_VERSION_0_10.

If you use any functions that is defined by newer version than GARROW_VERSION_MIN_REQUIRED, deprecated warnings are produced at compile time.

You must define this macro before including the arrow-glib/arrow-glib.h header.

Since 0.10.0


GARROW_VERSION_MAX_ALLOWED

#define             GARROW_VERSION_MAX_ALLOWED

You can use this macro for compile time API version check.

This macro value must be one of the predefined version macros such as GARROW_VERSION_0_10.

If you use any functions that is defined by newer version than GARROW_VERSION_MAX_ALLOWED, deprecated warnings are produced at compile time.

You must define this macro before including the arrow-glib/arrow-glib.h header.

Since 0.10.0


GARROW_AVAILABLE_IN_ALL

#define             GARROW_AVAILABLE_IN_ALL


GARROW_DEPRECATED_IN_0_10

#define             GARROW_DEPRECATED_IN_0_10

GARROW_DEPRECATED_IN_0_10 is deprecated and should not be used in newly-written code.


GARROW_AVAILABLE_IN_0_10

#define             GARROW_AVAILABLE_IN_0_10