gaia::ecs::CursorResult< T > Struct Template Reference

Result of reading or writing through a ComponentCursor. More...

#include <component_cursor.h>

Public Member Functions
GAIA_NODISCARD bool	ok () const noexcept
GAIA_NODISCARD	operator bool () const noexcept

Public Attributes
CursorStatus	status = CursorStatus::Invalid
	Operation status.
T	value {}
	Value returned by a successful read operation.

Detailed Description

template<typename T>
struct gaia::ecs::CursorResult< T >

Result of reading or writing through a ComponentCursor.

Template Parameters

T	Value type returned by the operation.

Member Function Documentation

ok()

template<typename T >

GAIA_NODISCARD bool gaia::ecs::CursorResult< T >::ok ( ) const

inlinenoexcept

Returns

True when the operation succeeded.

operator bool()

template<typename T >

GAIA_NODISCARD gaia::ecs::CursorResult< T >::operator bool ( ) const

inlineexplicitnoexcept

Returns

True when the operation succeeded.

---

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

• /home/runner/work/gaia-ecs/gaia-ecs/include/gaia/ecs/component_cursor.h