assert_null.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <format>
#include <string_view>
#include <utility>
 
#include <kaycxx/assert/assertion_error.hpp>
#include <kaycxx/assert/detail/source_location.hpp>
#include <kaycxx/assert/detail/nullable.hpp>
#include <kaycxx/assert/detail/to_string.hpp>
 
namespace kaycxx::assert {
 
template <detail::nullable T>
void assert_null(
    T const& actual,
    std::string_view reason = {},
    std::optional<std::source_location> location = KAYCXX_ASSERT_DEFAULT_SOURCE
) {
    if (!(actual == nullptr)) {
        auto actual_string = detail::to_string(actual);
        auto message = std::format("Expected <{}> to be null", actual_string);
        throw assertion_error(
            message,
            reason,
            std::move(actual_string),
            "null",
            location
        );
    }
}
 
} // namespace kaycxx::assert