dotnamecpp::utils::IPlatformInfo Class Reference

#include <IPlatformInfo.hpp>

Inheritance diagram for dotnamecpp::utils::IPlatformInfo:

Collaboration diagram for dotnamecpp::utils::IPlatformInfo:

Public Member Functions
virtual	~IPlatformInfo ()=default
virtual Platform	getPlatform () const =0
	Get the Platform object.
virtual std::string	getPlatformName () const =0
	Get the Platform Name object.
virtual Result< std::filesystem::path, FileError >	getExecutablePath () const =0
	Get the Executable Path object.
virtual Result< std::filesystem::path, FileError >	getExecutableDirectory () const =0
	Get the Executable Directory object.
virtual bool	isWindows () const =0
	Check if the platform is Windows.
virtual bool	isLinux () const =0
	Check if the platform is Linux.
virtual bool	isMacOS () const =0
	Check if the platform is macOS.
virtual bool	isEmscripten () const =0
	Check if the platform is Emscripten.

Constructor & Destructor Documentation

~IPlatformInfo()

virtual dotnamecpp::utils::IPlatformInfo::~IPlatformInfo ( )

virtualdefault

Member Function Documentation

getExecutableDirectory()

virtual Result< std::filesystem::path, FileError > dotnamecpp::utils::IPlatformInfo::getExecutableDirectory ( ) const

nodiscardpure virtual

Get the Executable Directory object.

Returns

Result<std::filesystem::path, FileError>

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

getExecutablePath()

virtual Result< std::filesystem::path, FileError > dotnamecpp::utils::IPlatformInfo::getExecutablePath ( ) const

nodiscardpure virtual

Get the Executable Path object.

Returns

Result<std::filesystem::path, FileError>

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

getPlatform()

virtual Platform dotnamecpp::utils::IPlatformInfo::getPlatform ( ) const

nodiscardpure virtual

Get the Platform object.

Returns

Platform

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

getPlatformName()

virtual std::string dotnamecpp::utils::IPlatformInfo::getPlatformName ( ) const

nodiscardpure virtual

Get the Platform Name object.

Returns

std::string

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

isEmscripten()

virtual bool dotnamecpp::utils::IPlatformInfo::isEmscripten ( ) const

nodiscardpure virtual

Check if the platform is Emscripten.

Returns

true

false

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

isLinux()

virtual bool dotnamecpp::utils::IPlatformInfo::isLinux ( ) const

nodiscardpure virtual

Check if the platform is Linux.

Returns

true

false

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

isMacOS()

virtual bool dotnamecpp::utils::IPlatformInfo::isMacOS ( ) const

nodiscardpure virtual

Check if the platform is macOS.

Returns

true

false

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

isWindows()

virtual bool dotnamecpp::utils::IPlatformInfo::isWindows ( ) const

nodiscardpure virtual

Check if the platform is Windows.

Returns

true

false

Implemented in dotnamecpp::utils::EmscriptenPlatformInfo, dotnamecpp::utils::UnixPlatformInfo, and dotnamecpp::utils::WindowsPlatformInfo.

---

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

• src/Utils/Platform/IPlatformInfo.hpp