tenant_id.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_UTILITY_UUID_TENANT_ID_HPP
#define ORES_UTILITY_UUID_TENANT_ID_HPP
 
#include <string>
#include <ostream>
#include <optional>
#include <expected>
#include <string_view>
#include <boost/uuid/uuid.hpp>
 
namespace ores::utility::uuid {
 
inline constexpr char nil_uuid_str[] = "00000000-0000-0000-0000-000000000000";
 
inline constexpr char max_uuid_str[] = "ffffffff-ffff-ffff-ffff-ffffffffffff";
 
class tenant_id final {
public:
    static tenant_id system();
 
    static std::expected<tenant_id, std::string>
    from_uuid(const boost::uuids::uuid& uuid);
 
    static std::expected<tenant_id, std::string>
    from_string(std::string_view str);
 
    bool is_system() const noexcept;
 
    bool is_nil() const noexcept;
 
    const boost::uuids::uuid& to_uuid() const noexcept;
 
    std::string to_string() const;
 
    bool operator==(const tenant_id& other) const noexcept = default;
 
private:
    explicit tenant_id(boost::uuids::uuid uuid);
 
    boost::uuids::uuid uuid_;
};
 
inline std::ostream& operator<<(std::ostream& os, const tenant_id& id) {
    return os << id.to_string();
}
 
inline std::ostream& operator<<(std::ostream& os, const std::optional<tenant_id>& id) {
    if (id.has_value()) {
        return os << id->to_string();
    }
    return os << "(none)";
}
 
}
 
#endif