cdt::ergodic_moves::MoveError Struct Reference

Typed error returned by move preparation or private execution. More...

#include <Move_outcome.hpp>

Collaboration diagram for cdt::ergodic_moves::MoveError:

Public Member Functions
constexpr auto	message () const noexcept -> std::string_view
constexpr auto	move () const noexcept -> move_tracker::MoveType
auto	operator== (MoveError const &other) const -> bool=default
constexpr auto	reason () const noexcept -> MoveFailure

Public Attributes
MoveFailure	category
	Structured rejection or execution-failure category.
move_tracker::MoveType	requested_move
	Pachner move whose proposal or execution failed.

Detailed Description

Typed error returned by move preparation or private execution.

The representation is allocation-free. Human-readable text is derived at the presentation boundary rather than stored in the hot path.

Definition at line 36 of file Move_outcome.hpp.

Member Function Documentation

message()

auto cdt::ergodic_moves::MoveError::message ( ) const -> std::string_view

inlinenodiscardconstexprnoexcept

Returns

A stable diagnostic for logs and command-line presentation.

Definition at line 52 of file Move_outcome.hpp.

References category, CAUSAL_INVALIDITY, EXECUTION_FAILURE, INVALID_TOPOLOGY, INVARIANT_VIOLATION, NO_CANDIDATE, STALE_CANDIDATE, and UNKNOWN_MOVE.

move()

auto cdt::ergodic_moves::MoveError::move ( ) const -> move_tracker::MoveType

inlinenodiscardconstexprnoexcept

Returns

The requested Pachner move.

Definition at line 48 of file Move_outcome.hpp.

References requested_move.

operator==()

auto cdt::ergodic_moves::MoveError::operator== ( MoveError const & other ) const -> bool=default

default

Parameters

other

Error to compare.

Returns

Whether category and requested move are equal.

reason()

auto cdt::ergodic_moves::MoveError::reason ( ) const -> MoveFailure

inlinenodiscardconstexprnoexcept

Returns

The structured rejection or execution-failure category.

Definition at line 44 of file Move_outcome.hpp.

References category.

Member Data Documentation

category

MoveFailure cdt::ergodic_moves::MoveError::category

Structured rejection or execution-failure category.

Definition at line 39 of file Move_outcome.hpp.

Referenced by message(), and reason().

requested_move

move_tracker::MoveType cdt::ergodic_moves::MoveError::requested_move

Pachner move whose proposal or execution failed.

Definition at line 41 of file Move_outcome.hpp.

Referenced by move().

---

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

• include/Move_outcome.hpp