plugify::PluginReferenceDescriptorRef Class Reference

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

#include <plugin_reference_descriptor.hpp>

Inheritance diagram for plugify::PluginReferenceDescriptorRef:

Collaboration diagram for plugify::PluginReferenceDescriptorRef:

Public Member Functions
std::string_view	GetName () const noexcept
	< Inherit constructors from Ref<const PluginReferenceDescriptor>. More...
bool	IsOptional () const noexcept
	Checks if the referenced plugin is optional. More...
std::span< std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the referenced plugin. More...
std::optional< int32_t >	GetRequestedVersion () const noexcept
	Retrieves the requested version of the referenced plugin, if specified. More...
Public Member Functions inherited from plugify::Ref< const PluginReferenceDescriptor >
	Ref (const PluginReferenceDescriptor &impl) noexcept
	Ref (Ref const &)=default
	Ref (Ref &&)=default
bool	operator== (const Ref &other) const noexcept
bool	operator== (const const PluginReferenceDescriptor *impl) const noexcept
Ref &	operator= (const Ref &) &=default
Ref &	operator= (const Ref &) &&=delete
Ref &	operator= (Ref &&) &=default
Ref &	operator= (Ref &&) &&=delete
	operator bool () const noexcept

Additional Inherited Members
Protected Attributes inherited from plugify::Ref< const PluginReferenceDescriptor >
const PluginReferenceDescriptor *	_impl

Detailed Description

A reference class for the PluginReferenceDescriptor structure.

This class holds a reference to a PluginReferenceDescriptor object, allowing users to retrieve information about plugin dependencies, such as the plugin name, optionality, supported platforms, and requested version.

Definition at line 20 of file plugin_reference_descriptor.hpp.

Member Function Documentation

GetName()

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

noexcept

< Inherit constructors from Ref<const PluginReferenceDescriptor>.

Retrieves the name of the referenced plugin.

Returns

A string view representing the name of the plugin.

GetRequestedVersion()

std::optional<int32_t> plugify::PluginReferenceDescriptorRef::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<std::string_view> plugify::PluginReferenceDescriptorRef::GetSupportedPlatforms ( ) const

noexcept

Retrieves the supported platforms for the referenced plugin.

Returns

A span of string views representing the supported platforms.

IsOptional()

bool plugify::PluginReferenceDescriptorRef::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