libmicroemu::ExecResult Class Reference

Returned by the libmicroemu::Machine::Exec method. Contains the status code of the execution and the program exit code. More...

#include <exec_result.h>

Public Member Functions
	ExecResult (StatusCode status_code, int program_exit_code) noexcept
	Constructs a new ExecResult object.
	ExecResult (ExecResult &&r) noexcept=default
	Move Constructor.
ExecResult &	operator= (ExecResult &&r)=delete
	Move Assignment.
	ExecResult (const ExecResult &r) noexcept=default
	Copy Constructor.
ExecResult &	operator= (const ExecResult &r)=delete
	Copy Assignment.
bool	IsOk () const noexcept
	Checks if the execution result is a success.
bool	IsErr () const noexcept
	Checks if the execution result is an error.
bool	IsMaxInstructionsReached () const noexcept
	Checks if the maximum number of instructions has been reached.
std::string_view	ToString () const noexcept
	Converts the contained status code to a string.
StatusCode	GetStatusCode () const noexcept
	Gets the status code of the execution result.
u32	GetProgramExitCode () const noexcept
	Gets the program exit code.

Detailed Description

Returned by the libmicroemu::Machine::Exec method. Contains the status code of the execution and the program exit code.

Member Function Documentation

GetProgramExitCode()

u32 libmicroemu::ExecResult::GetProgramExitCode ( ) const

inlinenoexcept

Gets the program exit code.

Returns

The program exit code.

GetStatusCode()

StatusCode libmicroemu::ExecResult::GetStatusCode ( ) const

inlinenoexcept

Gets the status code of the execution result.

Returns

The status code of the execution result.

See also

StatusCode

IsErr()

bool libmicroemu::ExecResult::IsErr ( ) const

inlinenoexcept

Checks if the execution result is an error.

Returns

true if the execution result is an error, false otherwise.

IsMaxInstructionsReached()

bool libmicroemu::ExecResult::IsMaxInstructionsReached ( ) const

inlinenoexcept

Checks if the maximum number of instructions has been reached.

Returns

true if the maximum number of instructions has been reached, false otherwise.

IsOk()

bool libmicroemu::ExecResult::IsOk ( ) const

inlinenoexcept

Checks if the execution result is a success.

Returns

true if the execution result is a success, false otherwise.

ToString()

std::string_view libmicroemu::ExecResult::ToString ( ) const

inlinenoexcept

Converts the contained status code to a string.

Returns

The string representation of the status code.

---

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

• include/libmicroemu/exec_result.h