StripeKit 0.1.1
Stripe integration toolkit for C++
Loading...
Searching...
No Matches
Version Information

Reading the StripeKit version and build metadata at runtime. More...

Collaboration diagram for Version Information:

Functions

std::string_view stripekit::version ()
 Returns the StripeKit version as a "major.minor.patch" string.
int stripekit::version_major ()
 Returns the major version number.
int stripekit::version_minor ()
 Returns the minor version number.
int stripekit::version_patch ()
 Returns the patch version number.
std::string_view stripekit::build_id ()
 Returns the identifier of the source revision this build came from.
std::string_view stripekit::build_date ()
 Returns the date this build was produced.

Detailed Description

Reading the StripeKit version and build metadata at runtime.

Function Documentation

◆ version()

std::string_view stripekit::version ( )

Returns the StripeKit version as a "major.minor.patch" string.

Returns
The version string, for example "0.1.0".

◆ version_major()

int stripekit::version_major ( )

Returns the major version number.

This changes when the API breaks compatibility with earlier releases.

Returns
The major version number.

◆ version_minor()

int stripekit::version_minor ( )

Returns the minor version number.

This changes when features are added in a backwards-compatible way.

Returns
The minor version number.

◆ version_patch()

int stripekit::version_patch ( )

Returns the patch version number.

Returns
The patch version number.

◆ build_id()

std::string_view stripekit::build_id ( )

Returns the identifier of the source revision this build came from.

Useful for pinning down exactly which build a bug report came from.

Returns
The revision identifier, or an empty string when it could not be determined at build time.

◆ build_date()

std::string_view stripekit::build_date ( )

Returns the date this build was produced.

Returns
The build date in ISO 8601 form.