Coverage Report

Created: 2024-11-29 06:10

/src/botan/build/include/internal/botan/internal/calendar.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
* Calendar Functions
3
* (C) 1999-2009,2015 Jack Lloyd
4
* (C) 2015 Simon Warta (Kullo GmbH)
5
*
6
* Botan is released under the Simplified BSD License (see license.txt)
7
*/
8
9
#ifndef BOTAN_CALENDAR_H_
10
#define BOTAN_CALENDAR_H_
11
12
#include <botan/types.h>
13
#include <chrono>
14
#include <string>
15
16
namespace Botan {
17
18
/**
19
* Struct representing a particular date and time
20
*/
21
class BOTAN_TEST_API calendar_point {
22
   public:
23
      /** The year */
24
592
      uint32_t year() const { return m_year; }
25
26
      /** The month, 1 through 12 for Jan to Dec */
27
592
      uint32_t month() const { return m_month; }
28
29
      /** The day of the month, 1 through 31 (or 28 or 30 based on month */
30
592
      uint32_t day() const { return m_day; }
31
32
      /** Hour in 24-hour form, 0 to 23 */
33
592
      uint32_t hour() const { return m_hour; }
34
35
      /** Minutes in the hour, 0 to 60 */
36
592
      uint32_t minutes() const { return m_minutes; }
37
38
      /** Seconds in the minute, 0 to 60, but might be slightly
39
      larger to deal with leap seconds on some systems
40
      */
41
592
      uint32_t seconds() const { return m_seconds; }
42
43
      /**
44
      * Initialize a calendar_point
45
      * @param y the year
46
      * @param mon the month
47
      * @param d the day
48
      * @param h the hour
49
      * @param min the minute
50
      * @param sec the second
51
      */
52
      calendar_point(uint32_t y, uint32_t mon, uint32_t d, uint32_t h, uint32_t min, uint32_t sec) :
53
0
            m_year(y), m_month(mon), m_day(d), m_hour(h), m_minutes(min), m_seconds(sec) {}
54
55
      /**
56
      * Convert a time_point to a calendar_point
57
      * @param time_point a time point from the system clock
58
      */
59
      calendar_point(const std::chrono::system_clock::time_point& time_point);
60
61
      /**
62
      * Returns an STL timepoint object
63
      */
64
      std::chrono::system_clock::time_point to_std_timepoint() const;
65
66
      /**
67
      * Returns a human readable string of the struct's components.
68
      * Formatting might change over time. Currently it is RFC339 'iso-date-time'.
69
      */
70
      std::string to_string() const;
71
72
   private:
73
      uint32_t m_year;
74
      uint32_t m_month;
75
      uint32_t m_day;
76
      uint32_t m_hour;
77
      uint32_t m_minutes;
78
      uint32_t m_seconds;
79
};
80
81
}  // namespace Botan
82
83
#endif