VoltMod::LoadReport Class Reference

#include <LoadReport.hpp>

Public Member Functions
bool	Optional (std::string_view name, Status result)
bool	Required (std::string_view name, Status result)
std::string	Summary () const
std::string	AbortReason () const
const std::vector< FailedCheck > &	Failures () const

Detailed Description

What went wrong while one plugin loaded. The runtime checks its own services here, and plugin members and Plugin::Load add theirs. Plugin logs Summary and refuses the load with AbortReason.

Definition at line 25 of file LoadReport.hpp.

Member Function Documentation

AbortReason()

std::string VoltMod::LoadReport::AbortReason

(

)

const

<name>: <reason> for the first required failure; empty when none failed.

Definition at line 47 of file LoadReport.cpp.

References VoltMod::ReadFile(), and VoltMod::FailedCheck::Required.

Failures()

const std::vector< FailedCheck > & VoltMod::LoadReport::Failures ( ) const

inline

Definition at line 40 of file LoadReport.hpp.

Optional()

bool VoltMod::LoadReport::Optional	(	std::string_view	name,
		Status	result
	)

Record result; a failure disables that feature. Returns whether it succeeded.

Definition at line 9 of file LoadReport.cpp.

References VoltMod::ReadFile().

Required()

bool VoltMod::LoadReport::Required	(	std::string_view	name,
		Status	result
	)

Record result; a failure refuses the plugin. Returns whether it succeeded.

Definition at line 14 of file LoadReport.cpp.

References VoltMod::ReadFile().

Summary()

std::string VoltMod::LoadReport::Summary

(

)

const

Load took N ms, then one line per failure.

Definition at line 29 of file LoadReport.cpp.

References VoltMod::ReadFile().

---

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

• include/VoltMod/Core/LoadReport.hpp
• src/Core/LoadReport.cpp