Enumeration concepts

Concepts and helpers for enum / enum class types. More...

Concepts
concept	StormByte::Type::Enum
	Unscoped or scoped enumeration (enum / enum class).
concept	StormByte::Type::UnsignedEnum
	Enum whose underlying type is unsigned.
concept	StormByte::Type::ScopedEnum
	Scoped enumeration (enum class / enum struct).

Typedefs
template<typename E >
using	StormByte::Type::UnderlyingType = std::underlying_type_t< std::remove_cv_t< E > >
	Underlying integer type of enumeration E.

Functions
template<typename E > requires Enum<E>
constexpr UnderlyingType< E >	StormByte::Type::ToUnderlying (E e) noexcept
	Converts an enumeration value to its underlying integer.

Detailed Description

Concepts and helpers for enum / enum class types.

Typedef Documentation

UnderlyingType

template<typename E >

using StormByte::Type::UnderlyingType = typedef std::underlying_type_t<std::remove_cv_t<E> >

Underlying integer type of enumeration E.

Template Parameters

E	Enumeration type satisfying Enum.

enum class Foo : uint16_t { A };
Type::UnderlyingType<Foo> value = 0;

Function Documentation

ToUnderlying()

template<typename E >
requires Enum<E>

constexpr UnderlyingType< E > StormByte::Type::ToUnderlying ( E  e )

constexprnoexcept

Converts an enumeration value to its underlying integer.

Template Parameters

E	Enumeration type satisfying Enum.

Parameters

[in]

e

Value to convert.

Returns

Underlying integer representation of e.

enum class Foo : int { A = 3 };
auto n = Type::ToUnderlying(Foo::A); // 3