managed.h

/************************************************************************************
 *
 * D++, A Lightweight C++ library for Discord
 *
 * SPDX-License-Identifier: Apache-2.0
 * Copyright 2021 Craig Edwards and D++ contributors 
 * (https://github.com/brainboxdotcc/DPP/graphs/contributors)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ************************************************************************************/
#pragma once
#include <dpp/export.h>
#include <dpp/snowflake.h>
#include <string>

namespace dpp {

/** @brief The managed class is the base class for various types that can
 * be stored in a cache that are identified by a dpp::snowflake id.
 */
class DPP_EXPORT managed {
public:
	/**
	 * @brief Unique ID of object set by Discord.
	 * This value contains a timestamp, worker ID, internal server ID, and an incrementing value.
	 * Only the timestamp is relevant to us as useful metadata.
	 */
	snowflake id = {};

	/**
	 * @brief Constructor, initialises id to 0.
	 */
	managed() = default;

	/**
	 * @brief Constructor, initialises ID
	 * @param nid ID to set
	 */
	managed(const snowflake nid) : id{nid} {}

	/**
	 * @brief Copy constructor
	 * @param rhs Object to copy
	 */
	managed(const managed &rhs) = default;

	/**
	 * @brief Move constructor
	 *
	 * Effectively equivalent to copy constructor
	 * @param rhs Object to move from
	 */
	managed(managed &&rhs) = default;

	/**
	 * @brief Destroy the managed object
	 */
	virtual ~managed() = default;

	/**
	 * @brief Copy assignment operator
	 * @param rhs Object to copy
	 */
	managed &operator=(const managed& rhs) = default;

	/**
	 * @brief Move assignment operator
	 * @param rhs Object to move from
	 */
	managed &operator=(managed&& rhs) = default;

	/**
	 * @brief Get the creation time of this object according to Discord.
	 *
	 * @return double creation time inferred from the snowflake ID.
	 * The minimum possible value is the first second of 2015.
	 */
	constexpr double get_creation_time() const noexcept {
		return id.get_creation_time();
	};

	/**
	 * @brief Comparison operator for comparing two managed objects by id
	 *
	 * @param other Other object to compare against
	 * @return true objects are the same id
	 * @return false objects are not the same id
	 */
	constexpr bool operator==(const managed& other) const noexcept {
		return id == other.id;
	}

	/**
	 * @brief Comparison operator for comparing two managed objects by id
	 *
	 * @param other Other object to compare against
	 * @return true objects are not the same id
	 * @return false objects are the same id
	 */
	constexpr bool operator!=(const managed& other) const noexcept {
		return id != other.id;
	}
};

}