C CASTLE / MODULE NOTES
CASTLE/Modules/Utility

MODULE 14 / 15

Utility

A standard-library-like subset of Castle utilities in a single convenience include.

#include "castle/utility/utility.hpp"

Overview

This is the umbrella header for Castle's utility layer. It exists for translation units that want the standard-library-like utility subset in a single include.

Dependencies

  • macros.hpp
  • forward.hpp
  • move.hpp
  • swap.hpp
  • bytes.hpp
  • bit_cast.hpp
  • tuple.hpp
  • pair.hpp
  • variant.hpp
  • optional.hpp
  • bitset.hpp
  • hash.hpp

Public API

This header adds no direct runtime API of its own. It re-exports:

  • macros.hpp
  • forward.hpp
  • move.hpp
  • swap.hpp
  • bytes.hpp
  • bit_cast.hpp
  • tuple.hpp
  • pair.hpp
  • variant.hpp
  • optional.hpp
  • bitset.hpp
  • hash.hpp

Usage example

See samples/sample_utility.cpp.

#include "castle/utility/utility.hpp"

Constraints & notes

  • Pulls in the full Castle utility surface listed above.
  • Does not allocate or define additional runtime state by itself.
  • Useful as a convenience include, but narrower includes may reduce compile time.