BS::version Struct Reference

A struct used to store a version number, which can be checked and compared at compilation time. More...

#include <BS_thread_pool.hpp>

Public Member Functions
constexpr	version (const std::uint64_t major_, const std::uint64_t minor_, const std::uint64_t patch_) noexcept
std::string	to_string () const

Public Attributes
std::uint64_t	major
std::uint64_t	minor
std::uint64_t	patch

Friends
constexpr friend bool	operator== (const version &lhs, const version &rhs) noexcept
constexpr friend bool	operator!= (const version &lhs, const version &rhs) noexcept
constexpr friend bool	operator< (const version &lhs, const version &rhs) noexcept
constexpr friend bool	operator>= (const version &lhs, const version &rhs) noexcept
constexpr friend bool	operator> (const version &lhs, const version &rhs) noexcept
constexpr friend bool	operator<= (const version &lhs, const version &rhs) noexcept
std::ostream &	operator<< (std::ostream &stream, const version &ver)

Detailed Description

A struct used to store a version number, which can be checked and compared at compilation time.

Constructor & Destructor Documentation

version()

constexpr BS::version::version ( const std::uint64_t  major_, const std::uint64_t  minor_, const std::uint64_t  patch_  )

inlineconstexprnoexcept

: major(major_), minor(minor_), patch(patch_) {}

Member Function Documentation

to_string()

std::string BS::version::to_string ( ) const

inline

    {
        return std::to_string(major) + '.' + std::to_string(minor) + '.' + std::to_string(patch);
    }

Friends And Related Symbol Documentation

operator==

constexpr friend bool operator== ( const version &  lhs, const version &  rhs  )

friend

    {
        return std::tuple(lhs.major, lhs.minor, lhs.patch) == std::tuple(rhs.major, rhs.minor, rhs.patch);
    }

operator!=

constexpr friend bool operator!= ( const version &  lhs, const version &  rhs  )

friend

    {
        return !(lhs == rhs);
    }

operator<

constexpr friend bool operator< ( const version &  lhs, const version &  rhs  )

friend

    {
        return std::tuple(lhs.major, lhs.minor, lhs.patch) < std::tuple(rhs.major, rhs.minor, rhs.patch);
    }

operator>=

constexpr friend bool operator>= ( const version &  lhs, const version &  rhs  )

friend

    {
        return !(lhs < rhs);
    }

operator>

constexpr friend bool operator> ( const version &  lhs, const version &  rhs  )

friend

    {
        return std::tuple(lhs.major, lhs.minor, lhs.patch) > std::tuple(rhs.major, rhs.minor, rhs.patch);
    }

operator<=

constexpr friend bool operator<= ( const version &  lhs, const version &  rhs  )

friend

    {
        return !(lhs > rhs);
    }

operator<<

std::ostream & operator<< ( std::ostream &  stream, const version &  ver  )

friend

    {
        stream << ver.to_string();
        return stream;
    }

---

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

• external/threadpool/include/BS_thread_pool.hpp