TRLC Platform Library  1.0.0
Header-only C++ library for compile-time platform detection and abstraction
trlc::platform::Version Struct Reference

Library version information. More...

#include <trlc/platform/core.hpp>

Static Public Member Functions

static static uint32_t asInteger ()
 Get the version as a 32-bit integer. More...
 
static static bool isAtLeast (int major, int minor=0, int patch=0)
 Check if this version is at least the specified version. More...
 

Static Public Attributes

static static int MAJOR = 1
 Major version number (breaking changes) More...
 
static static int MINOR = 0
 Minor version number (feature additions) More...
 
static static int PATCH = 0
 Patch version number (bug fixes) More...
 
static static const char * STRING = "1.0.0"
 Version string in semantic versioning format. More...
 

Detailed Description

Library version information.

Provides compile-time access to the library version number and version string for compatibility checking and reporting.

Definition at line 61 of file core.hpp.

Member Function Documentation

◆ asInteger()

static static uint32_t trlc::platform::Version::asInteger ( )
inlinestatic

Get the version as a 32-bit integer.

Returns
Version encoded as (major << 16) | (minor << 8) | patch
Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 78 of file core.hpp.

◆ isAtLeast()

static static bool trlc::platform::Version::isAtLeast ( int  major,
int  minor = 0,
int  patch = 0 
)
inlinestatic

Check if this version is at least the specified version.

Parameters
majorMinimum major version
minorMinimum minor version
patchMinimum patch version
Returns
true if current version >= specified version
Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 90 of file core.hpp.

Member Data Documentation

◆ MAJOR

static int trlc::platform::Version::MAJOR = 1
static

Major version number (breaking changes)

Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 63 of file core.hpp.

◆ MINOR

static int trlc::platform::Version::MINOR = 0
static

Minor version number (feature additions)

Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 66 of file core.hpp.

◆ PATCH

static int trlc::platform::Version::PATCH = 0
static

Patch version number (bug fixes)

Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 69 of file core.hpp.

◆ STRING

static const char* trlc::platform::Version::STRING = "1.0.0"
static

Version string in semantic versioning format.

Examples
/home/tranglc/sources/trlc-platform/include/trlc/platform/core.hpp.

Definition at line 72 of file core.hpp.


The documentation for this struct was generated from the following file: