byte_units.h

Go to the documentation of this file.

// Copyright (c) 2025-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_UTIL_BYTE_UNITS_H
#define BITCOIN_UTIL_BYTE_UNITS_H
 
#include <util/overflow.h>
 
#include <limits>
#include <stdexcept>
 
namespace util::detail {
template <unsigned SHIFT>
consteval uint64_t ByteUnitsToBytes(unsigned long long units)
{
    const auto bytes{CheckedLeftShift(units, SHIFT)};
    if (!bytes || *bytes > std::numeric_limits<uint64_t>::max()) {
        throw std::overflow_error("Too large");
    }
    return *bytes;
}
} // namespace util::detail
 
consteval uint64_t operator""_MiB(unsigned long long mebibytes)
{
    return util::detail::ByteUnitsToBytes<20>(mebibytes);
}
 
consteval uint64_t operator""_GiB(unsigned long long gibibytes)
{
    return util::detail::ByteUnitsToBytes<30>(gibibytes);
}
 
#endif // BITCOIN_UTIL_BYTE_UNITS_H