Tony Parker 2ea76c322f
Add an HTTP format style for both Date and DateComponents (#1127)
* Add an HTTP format style for both `Date` and `DateComponents`.

* Correct the comments to properly use DateComponents type

* Use default values instead of crashing when formatting date components with missing or invalid fields

* Use 59 seconds instead of 0 for leap second of 60 - this results in being off by only 1 second in this case instead of 59.

* Address some review feedback
2025-03-13 11:39:57 -07:00

84 lines
4.0 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
// MARK: Date Extensions
@available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
extension Date {
/// Converts `self` to its textual representation.
/// - Parameter format: The format for formatting `self`.
/// - Returns: A representation of `self` using the given `format`. The type of the representation is specified by `FormatStyle.FormatOutput`.
#if FOUNDATION_FRAMEWORK
public func formatted<F: Foundation.FormatStyle>(_ format: F) -> F.FormatOutput where F.FormatInput == Date {
format.format(self)
}
#else
public func formatted<F: FoundationEssentials.FormatStyle>(_ format: F) -> F.FormatOutput where F.FormatInput == Date {
format.format(self)
}
#endif // FOUNDATION_FRAMEWORK
// Parsing
/// Creates a new `Date` by parsing the given representation.
/// - Parameter value: A representation of a date. The type of the representation is specified by `ParseStrategy.ParseInput`.
/// - Parameters:
/// - value: A representation of a date. The type of the representation is specified by `ParseStrategy.ParseInput`.
/// - strategy: The parse strategy to parse `value` whose `ParseOutput` is `Date`.
#if FOUNDATION_FRAMEWORK
public init<T: Foundation.ParseStrategy>(_ value: T.ParseInput, strategy: T) throws where T.ParseOutput == Self {
self = try strategy.parse(value)
}
#else
public init<T: FoundationEssentials.ParseStrategy>(_ value: T.ParseInput, strategy: T) throws where T.ParseOutput == Self {
self = try strategy.parse(value)
}
#endif // FOUNDATION_FRAMEWORK
/// Creates a new `Date` by parsing the given string representation.
#if FOUNDATION_FRAMEWORK
@_disfavoredOverload
public init<T: Foundation.ParseStrategy, Value: StringProtocol>(_ value: Value, strategy: T) throws where T.ParseOutput == Self, T.ParseInput == String {
self = try strategy.parse(String(value))
}
#else
@_disfavoredOverload
public init<T: FoundationEssentials.ParseStrategy, Value: StringProtocol>(_ value: Value, strategy: T) throws where T.ParseOutput == Self, T.ParseInput == String {
self = try strategy.parse(String(value))
}
#endif // FOUNDATION_FRAMEWORK
}
@available(FoundationPreview 6.2, *)
extension DateComponents {
/// Converts `self` to its textual representation.
/// - Parameter format: The format for formatting `self`.
/// - Returns: A representation of `self` using the given `format`. The type of the representation is specified by `FormatStyle.FormatOutput`.
public func formatted<F: FormatStyle>(_ format: F) -> F.FormatOutput where F.FormatInput == DateComponents {
format.format(self)
}
// Parsing
/// Creates a new `DateComponents` by parsing the given representation.
/// - Parameter value: A representation of a date. The type of the representation is specified by `ParseStrategy.ParseInput`.
/// - Parameters:
/// - value: A representation of a date. The type of the representation is specified by `ParseStrategy.ParseInput`.
/// - strategy: The parse strategy to parse `value` whose `ParseOutput` is `DateComponents`.
public init<T: ParseStrategy>(_ value: T.ParseInput, strategy: T) throws where T.ParseOutput == Self {
self = try strategy.parse(value)
}
/// Creates a new `DateComponents` by parsing the given string representation.
@_disfavoredOverload
public init<T: ParseStrategy, Value: StringProtocol>(_ value: Value, strategy: T) throws where T.ParseOutput == Self, T.ParseInput == String {
self = try strategy.parse(String(value))
}
}