plugify::PluginReferenceDescriptorHandle Class Reference

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

#include <plugin_reference_descriptor.hpp>

Inheritance diagram for plugify::PluginReferenceDescriptorHandle:

Collaboration diagram for plugify::PluginReferenceDescriptorHandle:

Public Member Functions
std::string_view	GetName () const noexcept
	Retrieves the name of the referenced plugin.
bool	IsOptional () const noexcept
	Checks if the referenced plugin is optional.
std::span< const std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the referenced plugin.
std::optional< plg::version >	GetRequestedVersion () const noexcept
	Retrieves the requested version of the referenced plugin, if specified.
Public Member Functions inherited from plugify::Handle< const PluginReferenceDescriptor >
	Handle () noexcept
	Default constructor. Initializes the handle with a null pointer.
	Handle (const PluginReferenceDescriptor &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.
Handle &	operator= (const Handle &) &=default
	Comparison operator (<=>) for comparing two Handle objects.
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 PluginReferenceDescriptor >
const PluginReferenceDescriptor *	_impl
	A pointer to the referenced implementation of type T.

Detailed Description

A handle class for the PluginReferenceDescriptor structure.

Definition at line 18 of file plugin_reference_descriptor.hpp.

Member Function Documentation

GetName()

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

noexcept

Retrieves the name of the referenced plugin.

Returns

A string view representing the name of the plugin.

GetRequestedVersion()

std::optional< plg::version > plugify::PluginReferenceDescriptorHandle::GetRequestedVersion ( ) const

noexcept

Retrieves the requested version of the referenced plugin, if specified.

Returns

An optional integer representing the requested version. If no version is requested, returns an empty optional.

GetSupportedPlatforms()

std::span< const std::string_view > plugify::PluginReferenceDescriptorHandle::GetSupportedPlatforms ( ) const

noexcept

Retrieves the supported platforms for the referenced plugin.

Returns

A span of string views representing the supported platforms.

IsOptional()

bool plugify::PluginReferenceDescriptorHandle::IsOptional ( ) const

noexcept

Checks if the referenced plugin is optional.

Returns

true if the plugin is optional, otherwise false.

---

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

• include/plugify/plugin_reference_descriptor.hpp