Botan::calendar_point Class Reference

#include <calendar.h>

Public Member Functions
	calendar_point (uint32_t y, uint32_t mon, uint32_t d, uint32_t h, uint32_t min, uint32_t sec)
uint32_t	get_day () const
uint32_t	get_hour () const
uint32_t	get_minutes () const
uint32_t	get_month () const
uint32_t	get_seconds () const
uint32_t	get_year () const
std::chrono::system_clock::time_point	to_std_timepoint () const
std::string	to_string () const

Public Attributes
BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES	__pad0__: uint32_t year
uint32_t	day
uint32_t	hour
uint32_t	minutes
uint32_t	month
uint32_t	seconds

Detailed Description

Struct representing a particular date and time

Definition at line 21 of file calendar.h.

Constructor & Destructor Documentation

Botan::calendar_point::calendar_point ( uint32_t  y, uint32_t  mon, uint32_t  d, uint32_t  h, uint32_t  min, uint32_t  sec  )

inline

Initialize a calendar_point

Parameters

y	the year
mon	the month
d	the day
h	the hour
min	the minute
sec	the second

Definition at line 54 of file calendar.h.

                                                                                                   :
         year(y), month(mon), day(d), hour(h), minutes(min), seconds(sec) {}

Member Function Documentation

uint32_t Botan::calendar_point::get_day ( ) const

inline

The day of the month, 1 through 31 (or 28 or 30 based on month

Definition at line 32 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return day; }

uint32_t Botan::calendar_point::get_hour ( ) const

inline

Hour in 24-hour form, 0 to 23

Definition at line 35 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return hour; }

uint32_t Botan::calendar_point::get_minutes ( ) const

inline

Minutes in the hour, 0 to 60

Definition at line 38 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return minutes; }

uint32_t Botan::calendar_point::get_month ( ) const

inline

The month, 1 through 12 for Jan to Dec

Definition at line 29 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return month; }

uint32_t Botan::calendar_point::get_seconds ( ) const

inline

Seconds in the minute, 0 to 60, but might be slightly larger to deal with leap seconds on some systems

Definition at line 43 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return seconds; }

uint32_t Botan::calendar_point::get_year ( ) const

inline

The year

Definition at line 26 of file calendar.h.

Referenced by to_std_timepoint(), to_string(), and Botan::X509_Time::X509_Time().

{ return year; }

std::chrono::system_clock::time_point Botan::calendar_point::to_std_timepoint

(

)

const

Returns an STL timepoint object

Definition at line 60 of file calendar.cpp.

References BOTAN_IF_CONSTEXPR, get_day(), get_hour(), get_minutes(), get_month(), get_seconds(), and get_year().

Referenced by Botan::X509_Time::to_std_timepoint().

   {
   if(get_year() < 1970)
      throw Invalid_Argument("calendar_point::to_std_timepoint() does not support years before 1970");

   // 32 bit time_t ends at January 19, 2038
   // https://msdn.microsoft.com/en-us/library/2093ets1.aspx
   // Throw after 2037 if 32 bit time_t is used

   BOTAN_IF_CONSTEXPR(sizeof(std::time_t) == 4)
      {
      if(get_year() > 2037)
         {
         throw Invalid_Argument("calendar_point::to_std_timepoint() does not support years after 2037 on this system");
         }
      }

   // This upper bound is completely arbitrary
   if(get_year() >= 2400)
      {
      throw Invalid_Argument("calendar_point::to_std_timepoint() does not support years after 2400");
      }

   const uint64_t seconds_64 = (days_since_epoch(get_year(), get_month(), get_day()) * 86400) +
                                (get_hour() * 60 * 60) + (get_minutes() * 60) + get_seconds();

   const time_t seconds_time_t = static_cast<time_t>(seconds_64);

   if(seconds_64 - seconds_time_t != 0)
      {
      throw Invalid_Argument("calendar_point::to_std_timepoint time_t overflow");
      }

   return std::chrono::system_clock::from_time_t(seconds_time_t);
   }

std::string Botan::calendar_point::to_string

(

)

const

Returns a human readable string of the struct's components. Formatting might change over time. Currently it is RFC339 'iso-date-time'.

Definition at line 96 of file calendar.cpp.

References get_day(), get_hour(), get_minutes(), get_month(), get_seconds(), and get_year().

   {
   // desired format: <YYYY>-<MM>-<dd>T<HH>:<mm>:<ss>
   std::stringstream output;
   output << std::setfill('0')
          << std::setw(4) << get_year() << "-"
          << std::setw(2) << get_month() << "-"
          << std::setw(2) << get_day() << "T"
          << std::setw(2) << get_hour() << ":"
          << std::setw(2) << get_minutes() << ":"
          << std::setw(2) << get_seconds();
   return output.str();
   }

Member Data Documentation

BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES Botan::calendar_point::__pad0__

Definition at line 73 of file calendar.h.

uint32_t Botan::calendar_point::day

Definition at line 75 of file calendar.h.

uint32_t Botan::calendar_point::hour

Definition at line 76 of file calendar.h.

uint32_t Botan::calendar_point::minutes

Definition at line 77 of file calendar.h.

uint32_t Botan::calendar_point::month

Definition at line 74 of file calendar.h.

uint32_t Botan::calendar_point::seconds

Definition at line 78 of file calendar.h.

---

The documentation for this class was generated from the following files:

• src/lib/utils/calendar.h
• src/lib/utils/calendar.cpp