Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dduan/nettime
RFC 3339 compliant date/time data types.
https://github.com/dduan/nettime
date datetime rfc-3339 time
Last synced: 2 months ago
JSON representation
RFC 3339 compliant date/time data types.
- Host: GitHub
- URL: https://github.com/dduan/nettime
- Owner: dduan
- License: mit
- Created: 2019-02-17T10:45:13.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2020-07-14T20:52:02.000Z (over 4 years ago)
- Last Synced: 2024-10-14T00:17:07.111Z (2 months ago)
- Topics: date, datetime, rfc-3339, time
- Language: Swift
- Size: 66.4 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NetTime
NetTime is a small collection of data types that represent date and time:
- **LocalTime**: A time of day without relationship to date or timezone.
- **LocalDate**: A date that represent an entire day in any timezone or calendar.
- **LocalDateTime**: A time and date independent of timezones and calendars.
- **TimeOffset**: Amount of hours and minutes difference from a timezone.
- **DateTime**: A moment in time, expressed in relationship to UTC in Gregorian
calendar, in the current era, between 0000AD and 9999AD.
Each type is capable of serializing and deserializing from strings format
specified in [RFC 3339][].
```swift
let date = DateTime(staticRFC3339String: "1979-05-27T00:32:00.999999-07:00")
// Original representation is preserved. For example:
date.time.secondFraction // [9, 9, 9, 9, 9, 9]
// Serialize back to RFC 3339 timestamp.
date.description // 1979-05-27T00:32:00.999999-07:00
// Use it with Foundation:
Foundation.Date(timeIntervalSinceReferenceDate: date.timeIntervalSince2001)
Foundation.TimeZone(secondsFromGMT: date.utcOffset.asSeconds)
```
## Why?
But why not just ues `Foundation.Date`, you ask?
Turns out, time is hard to represent if you account for different calendars
and timezones. But sometimes it's legitimate to ignore this problem. That's why
[RFC 3339][] exists: "to improve consistency and interoperability when
representing and using date and time in Internet protocols." Suffice to say,
_consistency and interoperability_ [goes beyond internet protocols][TOML Date].
Further, converting a timestamp to a in-memory object such as `TimeInterval` or
a `Foundation.Date` a destructive operation: the original time representation is
lost. Want to know what timezone offset was used? what the intended precesion
for the fraction of seconds was? Tough luck. NetTime preserves all information
in an RFC 3339-compliant timestamp.
## Installation
#### With [CocoaPods](http://cocoapods.org/)
```ruby
use_frameworks!
pod "NetTime"
```
#### With [SwiftPM](https://swift.org/package-manager)
```
.package(url: "http://github.com/dduan/NetTime", from: "0.2.3")
```
## Caution
**Do not use** NetTime's data types as direct source for time displayed to end
users. Use something like `Foundation.DateFormatter` and follow best practices.
Never assume you know enough about timezones and/or calendars to format date
string!
[RFC 3339]: https://tools.ietf.org/html/rfc3339
[TOML Date]: https://toml.io/en/v1.0.0-rc.1#offset-date-time
## License
MIT. See `LICENSE.md`.