peak::core::Version Class Reference

Implements versioning functionality. More...

#include <peak/version/peak_version.hpp>

Public Member Functions
	Version ()=delete
	Version (uint32_t major, uint32_t minor, uint32_t patch)
	~Version ()=default
	Version (const Version &other)=default
Version &	operator= (const Version &other)=default
	Version (Version &&other)=default
Version &	operator= (Version &&other)=default
PEAK_COMMON_NO_DISCARD std::string	ToString () const
	Returns the version as string.
PEAK_COMMON_NO_DISCARD uint32_t	Major () const
	Returns the major part of the version which is the first part of the version scheme separated by dots.
PEAK_COMMON_NO_DISCARD uint32_t	Minor () const
	Returns the minor part of the version which is the second part of the version scheme separated by dots.
PEAK_COMMON_NO_DISCARD uint32_t	Subminor () const
PEAK_COMMON_NO_DISCARD uint32_t	Patch () const
	Returns the minor part of the version which is the second part of the version scheme separated by dots.

Detailed Description

Implements versioning functionality.

This class allows to create and compare different versions.

Constructor & Destructor Documentation

Version() [1/4]

peak::core::Version::Version ( )

delete

Version() [2/4]

peak::core::Version::Version ( uint32_t major, uint32_t minor, uint32_t patch )

inline

~Version()

peak::core::Version::~Version ( )

default

Version() [3/4]

peak::core::Version::Version ( const Version & other )

default

Version() [4/4]

peak::core::Version::Version ( Version && other )

default

Member Function Documentation

Major()

uint32_t peak::core::Version::Major ( ) const

inline

Returns the major part of the version which is the first part of the version scheme separated by dots.

Returns

x.y.z

Since

1.0

Minor()

uint32_t peak::core::Version::Minor ( ) const

inline

Returns the minor part of the version which is the second part of the version scheme separated by dots.

Returns

x.y.z

Since

1.0

operator=() [1/2]

Version & peak::core::Version::operator= ( const Version & other )

default

operator=() [2/2]

Version & peak::core::Version::operator= ( Version && other )

default

Patch()

uint32_t peak::core::Version::Patch ( ) const

inline

Returns the minor part of the version which is the second part of the version scheme separated by dots.

Returns

x.y.z

Since

1.18

Subminor()

uint32_t peak::core::Version::Subminor ( ) const

inline

Deprecated

Deprecated due to SemVer 2.0 migration. Use Patch() instead.

ToString()

std::string peak::core::Version::ToString ( ) const

inline

Returns the version as string.

Since

1.0

---

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

• peak/version/peak_version.hpp