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
|
# `rfl::Timestamp`
`rfl::Timestamp` is a simple wrapper around `std::tm` (https://en.cppreference.com/w/cpp/chrono/c/tm).
As its template parameter it includes the time stamp format for serialization and deserialization.
Here is a reference for for how you can specify the format:
https://en.cppreference.com/w/cpp/chrono/c/strftime
In fact, `rfl::Timestamp` calls `strftime` and `strptime` under-the-hood.
They can be used in your struct like this:
```cpp
struct Person {
rfl::Field<"birthday", rfl::Timestamp<"%Y-%m-%d">> birthday;
};
```
An `rfl::Timestamp` can be constructed from either a string or a `std::tm` struct.
```cpp
const auto person1 = Person{.birthday = "1970-01-01"};
const auto person2 = Person{.birthday = std::tm{...}};
```
You can access the underlying `std::tm` struct using the `.tm()` method and you can generate
the string representation using the `.str()` method.
```cpp
const std::tm birthday = person1.birthday().tm();
std::cout << person1.birthday().str() << std::endl;
```
Note that constructing `rfl::Timestamp` from a string is convenient, but it might result in
an exception.
To avoid the exception you can also use `Timestamp<...>::from_string(...)`, which will
return an `rfl::Result<Timestamp<...>>` or `rfl::Error`.
```cpp
const rfl::Result<rfl::Timestamp<"%Y-%m-%d">> result = rfl::Timestamp<"%Y-%m-%d">::from_string("1970-01-01");
const rfl::Result<rfl::Timestamp<"%Y-%m-%d">> error = rfl::Timestamp<"%Y-%m-%d">::from_string("not a proper time format");
```
|