plugify::PluginDescriptorHandle Class Reference

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

#include <plugin_descriptor.hpp>

Inheritance diagram for plugify::PluginDescriptorHandle:

Collaboration diagram for plugify::PluginDescriptorHandle:

Public Member Functions
int32_t	GetFileVersion () const noexcept
	Retrieves the file version of the plugin.
plg::version	GetVersion () const noexcept
	Retrieves the version of the plugin.
std::string_view	GetVersionName () const noexcept
	Retrieves the version name of the plugin.
std::string_view	GetFriendlyName () const noexcept
	Retrieves the friendly name of the plugin.
std::string_view	GetDescription () const noexcept
	Retrieves the description of the plugin.
std::string_view	GetCreatedBy () const noexcept
	Retrieves the name of the creator of the plugin.
std::string_view	GetCreatedByURL () const noexcept
	Retrieves the URL of the creator of the plugin.
std::string_view	GetDocsURL () const noexcept
	Retrieves the documentation URL for the plugin.
std::string_view	GetDownloadURL () const noexcept
	Retrieves the download URL for the plugin.
std::string_view	GetUpdateURL () const noexcept
	Retrieves the update URL for the plugin.
std::span< const std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the plugin.
std::span< const std::string_view >	GetResourceDirectories () const noexcept
	Retrieves the resource directories for the plugin.
std::string_view	GetEntryPoint () const noexcept
	Retrieves the entry point of the plugin.
std::string_view	GetLanguageModule () const noexcept
	Retrieves the language module used by the plugin.
std::span< const PluginReferenceDescriptorHandle >	GetDependencies () const noexcept
	Retrieves the dependencies of the plugin.
std::span< const MethodHandle >	GetExportedMethods () const noexcept
	Retrieves the methods exported by the plugin.
Public Member Functions inherited from plugify::Handle< const PluginDescriptor >
	Handle () noexcept
	Default constructor. Initializes the handle with a null pointer.
	Handle (const PluginDescriptor &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 PluginDescriptor >
const PluginDescriptor *	_impl
	A pointer to the referenced implementation of type T.

Detailed Description

A handle class for the PluginDescriptor structure.

Definition at line 21 of file plugin_descriptor.hpp.

Member Function Documentation

GetCreatedBy()

std::string_view plugify::PluginDescriptorHandle::GetCreatedBy ( ) const

noexcept

Retrieves the name of the creator of the plugin.

Returns

A string view representing the name of the creator.

GetCreatedByURL()

std::string_view plugify::PluginDescriptorHandle::GetCreatedByURL ( ) const

noexcept

Retrieves the URL of the creator of the plugin.

Returns

A string view representing the creator's URL.

GetDependencies()

std::span< const PluginReferenceDescriptorHandle > plugify::PluginDescriptorHandle::GetDependencies ( ) const

noexcept

Retrieves the dependencies of the plugin.

Returns

A span of PluginReferenceDescriptorRef objects representing the plugin's dependencies.

GetDescription()

std::string_view plugify::PluginDescriptorHandle::GetDescription ( ) const

noexcept

Retrieves the description of the plugin.

Returns

A string view representing the plugin description.

GetDocsURL()

std::string_view plugify::PluginDescriptorHandle::GetDocsURL ( ) const

noexcept

Retrieves the documentation URL for the plugin.

Returns

A string view representing the documentation URL.

GetDownloadURL()

std::string_view plugify::PluginDescriptorHandle::GetDownloadURL ( ) const

noexcept

Retrieves the download URL for the plugin.

Returns

A string view representing the download URL.

GetEntryPoint()

std::string_view plugify::PluginDescriptorHandle::GetEntryPoint ( ) const

noexcept

Retrieves the entry point of the plugin.

Returns

A string view representing the plugin's entry point.

GetExportedMethods()

std::span< const MethodHandle > plugify::PluginDescriptorHandle::GetExportedMethods ( ) const

noexcept

Retrieves the methods exported by the plugin.

Returns

A span of MethodRef objects representing the exported methods.

GetFileVersion()

int32_t plugify::PluginDescriptorHandle::GetFileVersion ( ) const

noexcept

Retrieves the file version of the plugin.

Returns

An integer representing the file version.

GetFriendlyName()

std::string_view plugify::PluginDescriptorHandle::GetFriendlyName ( ) const

noexcept

Retrieves the friendly name of the plugin.

Returns

A string view representing the friendly name.

GetLanguageModule()

std::string_view plugify::PluginDescriptorHandle::GetLanguageModule ( ) const

noexcept

Retrieves the language module used by the plugin.

Returns

A string view representing the language module.

GetResourceDirectories()

std::span< const std::string_view > plugify::PluginDescriptorHandle::GetResourceDirectories ( ) const

noexcept

Retrieves the resource directories for the plugin.

Returns

A span of string views representing the resource directories.

GetSupportedPlatforms()

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

noexcept

Retrieves the supported platforms for the plugin.

Returns

A span of string views representing the supported platforms.

GetUpdateURL()

std::string_view plugify::PluginDescriptorHandle::GetUpdateURL ( ) const

noexcept

Retrieves the update URL for the plugin.

Returns

A string view representing the update URL.

GetVersion()

plg::version plugify::PluginDescriptorHandle::GetVersion ( ) const

noexcept

Retrieves the version of the plugin.

Returns

A struct representing the plugin version.

GetVersionName()

std::string_view plugify::PluginDescriptorHandle::GetVersionName ( ) const

noexcept

Retrieves the version name of the plugin.

Returns

A string view representing the version name.

---

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

• include/plugify/plugin_descriptor.hpp