Struct Version

Struct Documentation

struct Version

Represents a semantic version such as major.minor.patch with optional metadata fields.

Public Functions

Version() = default

Construct a default version object.

inline Version(uint16_t maj, uint16_t min, uint16_t pat)

Construct a default version object with the specified version.

Parameters:

  • maj[in] – Major version number.

  • min[in] – Minor version number.

  • pat[in] – Patch version number.

inline std::string simple_version_string() const

Return the version as a string formatted as [major].

[minor].[patch] or [major].[minor].[patch]-[prerelease] depending on whether there is a prerelease value.

Returns:

the version formatted as a string.

Public Members

uint16_t major = {}

Major version number.

uint16_t minor = {}

Minor version number.

uint16_t patch = {}

Patch(or revision) version number.

std::string stage = {}

Release stage name, if present.

std::string machine = {}

Machine name, if present.

std::string prerelease = {}

Prerelease name (e.g. rc1), if present.

std::string build = {}

Build info, if present. Often a date string.