modules/platforms/cpp/ignite/common/ignite_timestamp.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 <cstdint>

namespace ignite {

/**
 * @brief A moment of time.
 *
 * This is modeled after java.time.Instant.
 */
class ignite_timestamp {
public:
    /**
     * Default constructor.
     */
    constexpr ignite_timestamp() noexcept = default;

    /**
     * Constructor.
     *
     * @param seconds Number of seconds since 00:00 hours, Jan 1, 1970 UTC.
     * @param nanos Fractional second component in nanoseconds, from 0 to 999,999,999.
     */
    constexpr ignite_timestamp(std::int64_t seconds, std::int32_t nanos)
        : m_seconds(seconds)
        , m_nanos(nanos) {
        // TODO: check that arguments are in valid ranges.
    }

    /**
     * Gets the number of seconds since 00:00 hours, Jan 1, 1970 UTC.
     */
    [[nodiscard]] constexpr std::int64_t get_epoch_second() const noexcept { return m_seconds; }

    /**
     * Gets the number of nanoseconds from the start of the second.
     */
    [[nodiscard]] constexpr std::int32_t get_nano() const noexcept { return m_nanos; }

    /**
     * compare to another value.
     *
     * @param other Instance to compare to.
     * @return Zero if equals, negative number if less, and positive if greater.
     */
    [[nodiscard]] constexpr int compare(const ignite_timestamp &other) const noexcept {
        if (m_seconds != other.m_seconds) {
            return m_seconds < other.m_seconds ? -1 : 1;
        }
        return m_nanos - other.m_nanos;
    }

private:
    /** Number of seconds since 00:00 hours, Jan 1, 1970 UTC. */
    std::int64_t m_seconds = 0;

    /** Fractional second component in nanoseconds. */
    std::int32_t m_nanos = 0;
};

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is equal to the second.
 */
constexpr bool operator==(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) == 0;
}

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is not equal to the second.
 */
constexpr bool operator!=(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) != 0;
}

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is less than the second.
 */
constexpr bool operator<(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) < 0;
}

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is less than or equal to the second.
 */
constexpr bool operator<=(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) <= 0;
}

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is greater than the second.
 */
constexpr bool operator>(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) > 0;
}

/**
 * @brief Comparison operator.
 *
 * @param lhs First value.
 * @param rhs Second value.
 * @return true If the first value is greater than or equal to the second.
 */
constexpr bool operator>=(const ignite_timestamp &lhs, const ignite_timestamp &rhs) noexcept {
    return lhs.compare(rhs) >= 0;
}

} // namespace ignite