ap::version Struct Reference

A helper structure used to represent a program's version. More...

#include <types.hpp>

Public Member Functions
std::string	str () const noexcept
	Converts the structure into a string in the v{major}.{minor}.{path} format.

Public Attributes
std::uint32_t	major = 0u
	The major version number.
std::uint32_t	minor = 0u
	The minor version number.
std::uint32_t	patch = 0u
	The patch number.

Friends
std::ostream &	operator<< (std::ostream &os, const version &v)
	The stream insertion operator.

Detailed Description

A helper structure used to represent a program's version.

Definition at line 23 of file types.hpp.

Member Function Documentation

str()

std::string ap::version::str ( ) const

inlinenoexcept

Converts the structure into a string in the v{major}.{minor}.{path} format.

Definition at line 29 of file types.hpp.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const version &  v  )

friend

The stream insertion operator.

Definition at line 34 of file types.hpp.

Member Data Documentation

major

std::uint32_t ap::version::major = 0u

The major version number.

Definition at line 24 of file types.hpp.

minor

std::uint32_t ap::version::minor = 0u

The minor version number.

Definition at line 25 of file types.hpp.

patch

std::uint32_t ap::version::patch = 0u

The patch number.

Definition at line 26 of file types.hpp.

---

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

• include/ap/types.hpp