1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2023 Sadie Powell <sadie@witchery.services>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
namespace Duration
{
/** Converts a string containing a duration to the number of seconds it
* represents returning 0 on error.
*
* The string should should be in the format 1y2w3d4h6m5s which represents
* one year, two weeks, three days, four hours, six minutes, and five
* seconds. If called with this duration 33,019,565 will be returned.
*
* @param str A string containing a duration.
* @return Either the number of seconds in the duration or 0 on error.
*/
CoreExport unsigned long From(const std::string& str);
/** Determines whether a duration string is valid.
* @param str The duration string to check.
*/
CoreExport bool IsValid(const std::string& str);
/** Converts a number of seconds to a duration string.
*
* e.g. 33,019,565 weill result in 1y2w3d4h6m5s which represents one year,
* two weeks, three days, four hours, six minutes, and five seconds.
*/
CoreExport std::string ToString(unsigned long duration);
/** Attempts to converts a string containing a duration to the number of
* seconds it represents returning whether the conversion succeeded.
*
* The string should should be in the format 1y2w3d4h6m5s which represents
* one year, two weeks, three days, four hours, six minutes, and five
* seconds. If called with this duration 33,019,565 will be returned.
*
* @param str A string containing a duration.
* @param duration The location to store the resulting duration.
* @return True if the conversion succeeded; otherwise, false.
*/
CoreExport bool TryFrom(const std::string& str, unsigned long& duration);
}
namespace Time
{
/** Converts a UNIX timestamp to a time string.
*
* e.g.
* @param ts The timestamp to convert to a string.
* @param format A snprintf format string to output the timestamp in.
* @param utc If the timestamp is a UTC timestamp then true or false if the
* timestamp is a local timestamp.
*/
CoreExport std::string ToString(time_t ts, const char* format = nullptr, bool utc = false);
}
|
