hyperion::assert

hyperion::assert is a C++20 library for all manner of runtime assertions. It includes assertions for verifying contract requirements (i.e. pre-conditions, post-conditions), assertions for verifying error conditions have not occurred, debug assertions, optimization suggestions, and more, all with stacktrace support, user-configurable handling, optional syntax highlighting, and expression decomposition.

Example

#include <hyperion/assert.h>

auto example() {
    const auto lambda = []() {
        return 4;
    };
    HYPERION_ASSERT_DEBUG(2 + lambda() == 7, "lambda() wasn't {}", 5);
}

See the Quick Start Guide for how to get started using hyperion::assert.

For an overview of each module, see the links in the left sidebar or below.

Getting Started

• Quick Start Guide
  • CMake
  • XMake

Quick Reference

• Index

Assertions

• hyperion::assert
  • hyperion::assert::backtrace
    • Backtrace
    • FormatStyle
      • Unstyled
      • Styled
    • format_backtrace()
  • hyperion::assert::highlight
    • highlight()
    • register_highlight()
    • register_highlight()
    • register_highlights()
    • register_highlights()
    • get_color()
    • hyperion::assert::highlight::RgbColor
      • explicit()
      • RgbColor()
      • explicit()
    • hyperion::assert::highlight::Color
      • Color()
      • explicit()
      • explicit()
      • is_term_color()
      • term_color()
      • is_rgb_color()
      • rgb_color()
      • hyperion::assert::highlight::Color::storage
        • explicit()
        • rgb_color
        • term_color
    • hyperion::assert::highlight::Highlight
      • kind
      • color
  • hyperion::assert::panic
    • HYPERION_PANIC
    • Handler
    • set_handler()
    • get_handler()
    • default_handler()
  • hyperion::assert::tokens
    • Identifier
    • Kind
    • hyperion::assert::tokens::Namespace
    • hyperion::assert::tokens::Type
    • hyperion::assert::tokens::Function
    • hyperion::assert::tokens::Variable
    • hyperion::assert::tokens::Keyword
    • hyperion::assert::tokens::String
    • hyperion::assert::tokens::Numeric
    • hyperion::assert::tokens::Punctuation
    • hyperion::assert::tokens::Error
  • HYPERION_ASSERT_ASSUME
  • HYPERION_ASSERT_DEBUG
  • HYPERION_ASSERT_PRECONDITION
  • HYPERION_ASSERT_POSTCONDITION
  • HYPERION_ASSERT_REQUIRE
  • HYPERION_ASSERT_FATAL
  • HYPERION_ASSERT_EXPECT
  • HYPERION_ASSERT_UNEXPECT
  • HYPERION_ASSERT_DEBUG_BREAK
  • HYPERION_ATTRIBUTE_COLD
  • HYPERION_ATTRIBUTE_NO_INLINE

Source Location

• hyperion::source_location
  • hyperion::source_location
  • fmt::formatter< hyperion::source_location >