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
      • FormatStyle::Unstyled
      • FormatStyle::Styled
    • format_backtrace()
  • hyperion::assert::highlight
    • highlight()
    • register_highlight()
    • register_highlight()
    • register_highlights()
    • register_highlights()
    • get_color()
    • RgbColor
      • RgbColor::RgbColor()
      • RgbColor::RgbColor()
      • RgbColor::operator u32()
    • Color
      • Color::Color()
      • Color::Color()
      • Color::Color()
      • Color::is_term_color()
      • Color::term_color()
      • Color::is_rgb_color()
      • Color::rgb_color()
      • Color::storage
        • Color::storage::storage()
        • Color::storage::rgb_color
        • Color::storage::term_color
    • Highlight
      • Highlight::kind
      • Highlight::color
  • hyperion::assert::panic
    • Handler
    • set_handler()
    • get_handler()
    • default_handler()
  • hyperion::assert::tokens
    • Identifier
    • Kind
    • Namespace
    • Type
    • Function
    • Variable
    • Keyword
    • String
    • Numeric
    • Punctuation
    • Error

Source Location

• hyperion::source_location
  • source_location
  • formatter