plugify::LanguageModuleDescriptorHandle Class Reference

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

#include <language_module_descriptor.hpp>

Inheritance diagram for plugify::LanguageModuleDescriptorHandle:

Collaboration diagram for plugify::LanguageModuleDescriptorHandle:

Public Member Functions
int32_t	GetFileVersion () const noexcept
	Retrieves the file version of the language module.
plg::version	GetVersion () const noexcept
	Retrieves the version of the language module.
std::string_view	GetVersionName () const noexcept
	Retrieves the version name of the language module.
std::string_view	GetFriendlyName () const noexcept
	Retrieves the friendly name of the language module.
std::string_view	GetDescription () const noexcept
	Retrieves the description of the language module.
std::string_view	GetCreatedBy () const noexcept
	Retrieves the name of the creator of the language module.
std::string_view	GetCreatedByURL () const noexcept
	Retrieves the URL of the creator of the language module.
std::string_view	GetDocsURL () const noexcept
	Retrieves the documentation URL for the language module.
std::string_view	GetDownloadURL () const noexcept
	Retrieves the download URL for the language module.
std::string_view	GetUpdateURL () const noexcept
	Retrieves the update URL for the language module.
std::span< const std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the language module.
std::span< const std::string_view >	GetResourceDirectories () const noexcept
	Retrieves the resource directories for the language module.
std::span< const std::string_view >	GetLibraryDirectories () const noexcept
	Retrieves the library directories for the language module.
std::string_view	GetLanguage () const noexcept
	Retrieves the programming language of the language module.
bool	IsForceLoad () const noexcept
	Checks if the language module is forced to load.
Public Member Functions inherited from plugify::Handle< const LanguageModuleDescriptor >
	Handle () noexcept
	Default constructor. Initializes the handle with a null pointer.
	Handle (const LanguageModuleDescriptor &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 LanguageModuleDescriptor >
const LanguageModuleDescriptor *	_impl
	A pointer to the referenced implementation of type T.

Detailed Description

A handle class for the LanguageModuleDescriptor structure.

Definition at line 19 of file language_module_descriptor.hpp.

Member Function Documentation

GetCreatedBy()

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

noexcept

Retrieves the name of the creator of the language module.

Returns

A string view representing the name of the creator.

GetCreatedByURL()

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

noexcept

Retrieves the URL of the creator of the language module.

Returns

A string view representing the creator's URL.

GetDescription()

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

noexcept

Retrieves the description of the language module.

Returns

A string view representing the description.

GetDocsURL()

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

noexcept

Retrieves the documentation URL for the language module.

Returns

A string view representing the documentation URL.

GetDownloadURL()

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

noexcept

Retrieves the download URL for the language module.

Returns

A string view representing the download URL.

GetFileVersion()

int32_t plugify::LanguageModuleDescriptorHandle::GetFileVersion ( ) const

noexcept

Retrieves the file version of the language module.

Returns

An integer representing the file version.

GetFriendlyName()

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

noexcept

Retrieves the friendly name of the language module.

Returns

A string view representing the friendly name.

GetLanguage()

std::string_view plugify::LanguageModuleDescriptorHandle::GetLanguage ( ) const

noexcept

Retrieves the programming language of the language module.

Returns

A string view representing the language used by the module.

GetLibraryDirectories()

std::span< const std::string_view > plugify::LanguageModuleDescriptorHandle::GetLibraryDirectories ( ) const

noexcept

Retrieves the library directories for the language module.

Returns

A span of string views representing the library directories.

GetResourceDirectories()

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

noexcept

Retrieves the resource directories for the language module.

Returns

A span of string views representing the resource directories.

GetSupportedPlatforms()

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

noexcept

Retrieves the supported platforms for the language module.

Returns

A span of string views representing the supported platforms.

GetUpdateURL()

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

noexcept

Retrieves the update URL for the language module.

Returns

A string view representing the update URL.

GetVersion()

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

noexcept

Retrieves the version of the language module.

Returns

A struct representing the version.

GetVersionName()

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

noexcept

Retrieves the version name of the language module.

Returns

A string view representing the version name.

IsForceLoad()

bool plugify::LanguageModuleDescriptorHandle::IsForceLoad ( ) const

noexcept

Checks if the language module is forced to load.

Returns

true if the module is forced to load, otherwise false.

---

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

• include/plugify/language_module_descriptor.hpp