plugify::EnumHandle Class Reference

A handle class for the Enum structure. More...

#include <method.hpp>

Inheritance diagram for plugify::EnumHandle:

Collaboration diagram for plugify::EnumHandle:

Public Member Functions
std::string_view	GetName () const noexcept
	Retrieves the enum name.
std::span< const EnumValueHandle >	GetValues () const noexcept
	Retrieves the values contained within the enum.
Public Member Functions inherited from plugify::Handle< const Enum >
	Handle () noexcept
	Default constructor. Initializes the handle with a null pointer.
	Handle (const Enum &impl) noexcept
	Constructs a Handle object from an instance of type T.
	Handle (const Handle &)=default
	Copy constructor. Creates a new Handle object from another Handle object.
	Handle (Handle &&)=default
	Move constructor. Transfers ownership from another Handle object.
auto	operator<=> (const Handle &) const=default
	Comparison operator (<=>) for comparing two Handle objects.
Handle &	operator= (const Handle &) &=default
	Copy assignment operator. Copies the handle from another Handle object.
Handle &	operator= (const Handle &) &&=delete
	Copy assignment operator for rvalue references is deleted.
Handle &	operator= (Handle &&) &=default
	Move assignment operator. Transfers ownership from another Handle object.
Handle &	operator= (Handle &&) &&=delete
	Move assignment operator for rvalue references is deleted.
	operator bool () const noexcept
	Explicit conversion operator to bool, indicating if the pointer is non-zero.
	operator uintptr_t () const noexcept
	Converts the Handle object to a uintptr_t.
	operator void * () const noexcept
	Converts the Handle object to a void pointer.

Additional Inherited Members
Protected Attributes inherited from plugify::Handle< const Enum >
const Enum *	_impl
	A pointer to the referenced implementation of type T.

Detailed Description

A handle class for the Enum structure.

Definition at line 45 of file method.hpp.

Member Function Documentation

GetName()

std::string_view plugify::EnumHandle::GetName ( ) const

noexcept

Retrieves the enum name.

Returns

A string view representing the name of the enum.

GetValues()

std::span< const EnumValueHandle > plugify::EnumHandle::GetValues ( ) const

noexcept

Retrieves the values contained within the enum.

Returns

A span of EnumValueRef objects representing the values in the enum.

---

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

• include/plugify/method.hpp