helios::utils Namespace Reference

Namespaces
namespace	details

Classes
class	ChainAdapter
class	Defer
class	DynamicLibrary
class	EnumerateAdapter
class	FastPimpl
	Implements pimpl idiom without dynamic memory allocation. More...
class	FilterAdapter
class	FunctionalAdapterBase
class	InspectAdapter
class	JoinAdapter
class	MapAdapter
class	ReverseAdapter
class	SkipAdapter
class	SkipWhileAdapter
class	SlideAdapter
class	StepByAdapter
class	StrideAdapter
struct	StringEqual
	Transparent equality comparator for string types. More...
struct	StringHash
	Transparent hash functor for string types. More...
class	TakeAdapter
class	TakeWhileAdapter
class	ZipAdapter

Concepts
concept	ArithmeticTrait
concept	UniqueTypes
concept	IteratorLike
	Concept for types that can be used as base iterators in adapters.
concept	BidirectionalIteratorLike
	Concept for bidirectional iterators that support decrement operations.
concept	PredicateFor
	Concept for predicate functions that can be applied to iterator values.
concept	TransformFor
	Concept for transformation functions that can be applied to iterator values.
concept	InspectorFor
	Concept for inspection functions that observe but don't modify values.
concept	ActionFor
	Concept for action functions that process values.
concept	FolderFor
	Concept for folder functions that accumulate values.
concept	FilterAdapterRequirements
	Concept to validate FilterAdapter requirements.
concept	MapAdapterRequirements
	Concept to validate MapAdapter requirements.
concept	TakeAdapterRequirements
	Concept to validate TakeAdapter requirements.
concept	SkipAdapterRequirements
	Concept to validate SkipAdapter requirements.
concept	TakeWhileAdapterRequirements
	Concept to validate TakeWhileAdapter requirements.
concept	SkipWhileAdapterRequirements
	Concept to validate SkipWhileAdapter requirements.
concept	EnumerateAdapterRequirements
	Concept to validate EnumerateAdapter requirements.
concept	InspectAdapterRequirements
	Concept to validate InspectAdapter requirements.
concept	StepByAdapterRequirements
	Concept to validate StepByAdapter requirements.
concept	ChainAdapterRequirements
	Concept to validate ChainAdapter requirements.
concept	ReverseAdapterRequirements
	Concept to validate ReverseAdapter requirements.
concept	JoinAdapterRequirements
	Concept to validate JoinAdapter requirements.
concept	SlideAdapterRequirements
	Concept to validate SlideAdapter requirements.
concept	StrideAdapterRequirements
	Concept to validate StrideAdapter requirements.
concept	ZipAdapterRequirements
	Concept to validate ZipAdapter requirements.

Enumerations
enum class	DynamicLibraryError : uint8_t {   FileNotFound , LoadFailed , SymbolNotFound , InvalidHandle ,   AlreadyLoaded , NotLoaded , PlatformError }
	Error codes for dynamic library operations. More...
enum class	FileError : uint8_t { kCouldNotOpen , kReadError }

Functions
constexpr std::string_view	DynamicLibraryErrorToString (DynamicLibraryError error) noexcept
	Gets a human-readable description for a DynamicLibraryError.
auto	FromPath (const std::filesystem::path &path) -> std::expected< DynamicLibrary, DynamicLibraryError >
constexpr std::string_view	FileErrorToString (FileError error) noexcept
	Converts FileError to a human-readable string.
auto	ReadFileToString (std::string_view filepath) -> std::expected< std::string, FileError >
	Reads the entire contents of a file into a string.
auto	ReadFileToString (const std::filesystem::path &filepath) -> std::expected< std::string, FileError >
	Reads the entire contents of a file into a string.
constexpr std::string_view	GetFileName (std::string_view path)
	Extracts the file name from a given path.
static constexpr std::string_view	GetFileExtension (std::string_view path)
	Extracts the file extension from a given path.
template<typename OutIt >
constexpr void	Into (OutIt out) const
constexpr Derived &	GetDerived () noexcept
	Gets reference to derived class instance.

Enumeration Type Documentation

DynamicLibraryError

enum class helios::utils::DynamicLibraryError : uint8_t

strong

Error codes for dynamic library operations.

Enumerator
FileNotFound	Library file not found.
LoadFailed	Failed to load library.
SymbolNotFound	Symbol not found in library.
InvalidHandle	Invalid library handle.
AlreadyLoaded	Library is already loaded.
NotLoaded	Library is not loaded.
PlatformError	Platform-specific error.

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/dynamic_library.hpp.

Definition at line 19 of file dynamic_library.hpp.

                               : uint8_t {
  FileNotFound,    ///< Library file not found
  LoadFailed,      ///< Failed to load library
  SymbolNotFound,  ///< Symbol not found in library
  InvalidHandle,   ///< Invalid library handle
  AlreadyLoaded,   ///< Library is already loaded
  NotLoaded,       ///< Library is not loaded
  PlatformError,   ///< Platform-specific error
};

FileError

enum class helios::utils::FileError : uint8_t

strong

Enumerator
kCouldNotOpen
kReadError

Definition at line 16 of file filesystem.hpp.

: uint8_t { kCouldNotOpen, kReadError };

Function Documentation

DynamicLibraryErrorToString()

constexpr std::string_view helios::utils::DynamicLibraryErrorToString ( DynamicLibraryError  error )

constexprnoexcept

Gets a human-readable description for a DynamicLibraryError.

Parameters

error

The error code

Returns

String description of the error

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/dynamic_library.hpp.

Definition at line 34 of file dynamic_library.hpp.

                                                                                                       {
  switch (error) {
    case DynamicLibraryError::FileNotFound:
      return "Library file not found";
    case DynamicLibraryError::LoadFailed:
      return "Failed to load library";
    case DynamicLibraryError::SymbolNotFound:
      return "Symbol not found in library";
    case DynamicLibraryError::InvalidHandle:
      return "Invalid library handle";
    case DynamicLibraryError::AlreadyLoaded:
      return "Library is already loaded";
    case DynamicLibraryError::NotLoaded:
      return "Library is not loaded";
    case DynamicLibraryError::PlatformError:
      return "Platform-specific error";
    default:
      return "Unknown error";
  }
}

FileErrorToString()

constexpr std::string_view helios::utils::FileErrorToString ( FileError  error )

constexprnoexcept

Converts FileError to a human-readable string.

Parameters

error

The FileError to convert

Returns

A string view representing the error

Definition at line 23 of file filesystem.hpp.

                                                                                   {
  switch (error) {
    case FileError::kCouldNotOpen:
      return "Could not open file";
    case FileError::kReadError:
      return "Could not read file";
    default:
      return "Unknown file error";
  }
}

FromPath()

auto helios::utils::FromPath ( const std::filesystem::path &  path ) -> std::expected<DynamicLibrary, DynamicLibraryError>

inline

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/dynamic_library.hpp.

Definition at line 228 of file dynamic_library.hpp.

                                                                                                        {
  DynamicLibrary lib;
  if (const auto result = lib.Load(path); !result) {
    return std::unexpected(result.error());
  }
  return lib;
}

GetDerived()

constexpr const Derived & helios::utils::GetDerived ( )

constexprprotectednoexcept

Gets reference to derived class instance.

Gets const reference to derived class instance.

Returns

Reference to derived class

Const reference to derived class

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

Definition at line 2636 of file functional_adapters.hpp.

{ return static_cast<Derived&>(*this); }

GetFileExtension()

static constexpr std::string_view helios::utils::GetFileExtension ( std::string_view  path )

staticconstexpr

Extracts the file extension from a given path.

Parameters

path	The full file path

Returns

The file extension, including the dot (e.g., ".txt"), or an empty string if none exists

Definition at line 118 of file filesystem.hpp.

                                                                                    {
  const size_t last_dot = path.find_last_of('.');
  return (last_dot != std::string_view::npos) ? path.substr(last_dot) : "";
}

GetFileName()

constexpr std::string_view helios::utils::GetFileName ( std::string_view  path )

constexpr

Extracts the file name from a given path.

Parameters

path	The full file path

Returns

The file name

Definition at line 108 of file filesystem.hpp.

                                                                        {
  const size_t last_slash = path.find_last_of("/\\");
  return (last_slash != std::string_view::npos) ? path.substr(last_slash + 1) : path;
}

Into()

template<typename OutIt >

constexpr void helios::utils::Into ( OutIt  out ) const

constexpr

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/utils/functional_adapters.hpp.

ReadFileToString() [1/2]

auto helios::utils::ReadFileToString ( const std::filesystem::path &  filepath ) -> std::expected<std::string, FileError>

inline

Reads the entire contents of a file into a string.

Parameters

filepath

The path to the file

Returns

An expected containing the file contents or a FileError

Definition at line 73 of file filesystem.hpp.

                                         {
  if (filepath.empty()) {
    return std::unexpected(FileError::kCouldNotOpen);
  }
 
  std::ifstream in(filepath, std::ios::in | std::ios::binary);
  if (!in) {
    return std::unexpected(FileError::kCouldNotOpen);
  }
 
  std::string result;
  in.seekg(0, std::ios::end);
  const auto pos = in.tellg();
  if (pos == std::ifstream::pos_type(-1)) {
    return std::unexpected(FileError::kReadError);
  }
 
  const auto size = static_cast<size_t>(pos);
  result.resize(size);
  in.seekg(0, std::ios::beg);
  in.read(result.data(), static_cast<std::streamsize>(result.size()));
  if (!in) {
    return std::unexpected(FileError::kReadError);
  }
  in.close();
 
  return result;
}

ReadFileToString() [2/2]

auto helios::utils::ReadFileToString ( std::string_view  filepath ) -> std::expected<std::string, FileError>

inline

Reads the entire contents of a file into a string.

Parameters

filepath

The path to the file

Returns

An expected containing the file contents or a FileError

Definition at line 39 of file filesystem.hpp.

                                                                                                         {
  if (filepath.empty()) {
    return std::unexpected(FileError::kCouldNotOpen);
  }
 
  std::ifstream in(filepath.data(), std::ios::in | std::ios::binary);
  if (!in) {
    return std::unexpected(FileError::kCouldNotOpen);
  }
 
  std::string result;
  in.seekg(0, std::ios::end);
  const auto pos = in.tellg();
  if (pos == std::ifstream::pos_type(-1)) {
    return std::unexpected(FileError::kReadError);
  }
 
  const auto size = static_cast<size_t>(pos);
  result.resize(size);
  in.seekg(0, std::ios::beg);
  in.read(result.data(), static_cast<std::streamsize>(result.size()));
  if (!in) {
    return std::unexpected(FileError::kReadError);
  }
  in.close();
 
  return result;
}