date.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/utils/datetime/date.hpp
/// @brief @copybrief utils::datetime::Date
 
#include <chrono>
#include <iosfwd>
#include <stdexcept>
#include <string>
 
#include <userver/compiler/impl/three_way_comparison.hpp>
#include <userver/formats/common/meta.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace logging {
class LogHelper;
}
 
/// Date and time utilities
namespace utils::datetime {
 
/// @ingroup userver_universal userver_containers
///
/// @brief Date in format YYYY-MM-DD, std::chrono::year_month_day like type.
///
/// Convertible to std::sys_days and could be constructed from year,
/// month and day integers.
class Date final {
public:
    using Days = std::chrono::duration<long long, std::ratio<86400>>;
    using SysDays = std::chrono::time_point<std::chrono::system_clock, Days>;
 
    Date() = default;
    Date(const Date&) noexcept = default;
    Date& operator=(const Date&) noexcept = default;
 
    /// @brief Constructs Date without validation of input arguments
    Date(int year, int month, int day);
 
    /// @brief constructor from system clock time point in days.
    constexpr Date(SysDays tp) noexcept : sys_days_(tp) {}
 
    /// @brief Returns a time point corresponding to the date.
    ///
    /// This function may return the same time point, that was passed to
    /// constructor.
    constexpr SysDays GetSysDays() const { return sys_days_; }
 
    /// @copydoc GetSysDays()
    constexpr explicit operator SysDays() const { return sys_days_; }
 
#ifdef USERVER_IMPL_HAS_THREE_WAY_COMPARISON
    constexpr auto operator<=>(const Date&) const = default;
#else
    constexpr bool operator==(Date other) const { return sys_days_ == other.sys_days_; }
    constexpr bool operator!=(Date other) const { return !(*this == other); }
    constexpr bool operator<(Date other) const { return sys_days_ < other.sys_days_; }
    constexpr bool operator<=(Date other) const { return sys_days_ <= other.sys_days_; }
    constexpr bool operator>(Date other) const { return sys_days_ > other.sys_days_; }
    constexpr bool operator>=(Date other) const { return sys_days_ >= other.sys_days_; }
#endif
 
private:
    SysDays sys_days_{};
};
class Date final {…};
 
/// Validates date_string and constructs date from YYYY-MM-DD string and
Date DateFromRFC3339String(const std::string& date_string);
 
/// Outputs date as a YYYY-MM-DD string
std::string ToString(Date date);
 
template <typename Value>
std::enable_if_t<formats::common::kIsFormatValue<Value>, Date> Parse(const Value& value, formats::parse::To<Date>) {
    std::string str;
    try {
        str = value.template As<std::string>();
    } catch (const std::exception& e) {
        throw typename Value::ParseException("Only strings can be parsed as `utils::datetime::Date`");
    }
 
    try {
        return utils::datetime::DateFromRFC3339String(str);
    } catch (const std::exception& e) {
        throw typename Value::ParseException("'" + str + "' cannot be parsed to `utils::datetime::Date`");
    }
}
 
template <typename Value>
std::enable_if_t<formats::common::kIsFormatValue<Value>, Value> Serialize(Date date, formats::serialize::To<Value>) {
    return typename Value::Builder(ToString(date)).ExtractValue();
}
 
template <typename StringBuilder>
void WriteToStream(Date value, StringBuilder& sw) {
    WriteToStream(ToString(value), sw);
}
 
template <typename LogHelper = USERVER_NAMESPACE::logging::LogHelper>
USERVER_NAMESPACE::logging::LogHelper& operator<<(USERVER_NAMESPACE::logging::LogHelper& lh, const Date& date) {
    static_assert(
        std::is_same_v<LogHelper, USERVER_NAMESPACE::logging::LogHelper>,
        "This was made template to work well with forward declared "
        "logging::LogHelper"
    );
    return static_cast<LogHelper&>(lh) << ToString(date);
}
 
std::ostream& operator<<(std::ostream& os, Date date);
 
}  // namespace utils::datetime
 
USERVER_NAMESPACE_END