Facade operation result. More...

#include <flux_hal_types.hpp>

Static Public Member Functions
static constexpr HalResult	Ok () noexcept
	A success result.

static constexpr HalResult	Err (ManagerError c, uint32_t d=0) noexcept
	A failure result.

Public Attributes
bool	ok
	true on success

ManagerError	code
	None on success.

uint32_t	detail
	Optional manager / driver code (0 if unused)

Detailed Description

Facade operation result.

ok == true and code == ManagerError::None on success; otherwise code says why and detail may carry the manager's own operation code (for example an hf_valve_err_t) for logs.

Member Function Documentation

◆ Err()

static constexpr HalResult flux::hal::HalResult::Err	(	ManagerError	c,
		uint32_t	d = `0`
	)

inlinestaticconstexprnoexcept

A failure result.

Here is the caller graph for this function:

◆ Ok()

static constexpr HalResult flux::hal::HalResult::Ok ( )

inlinestaticconstexprnoexcept

A success result.

Here is the caller graph for this function:

Member Data Documentation

◆ code

ManagerError flux::hal::HalResult::code

None on success.

◆ detail

uint32_t flux::hal::HalResult::detail

Optional manager / driver code (0 if unused)

◆ ok

bool flux::hal::HalResult::ok

true on success

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

flux_hal_types.hpp

Static Public Member Functions

Public Attributes