struct · iOS 15.0+ · SDK 27.1
struct ISO8601FormatStyleA type that converts between dates and their ISO-8601 string representations. The ``Date/ISO8601FormatStyle`` type generates and parses string representations of dates following the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard, like `2024-04-01T12:34:56.789Z`. Use this type to create ISO-8601 representations of dates and create dates from text strings in ISO 8601 format. For other formatting conventions, like human-readable, localized date formats, use ``Date/FormatStyle``. Instance modifier methods applied to an ISO-8601 format style customize the formatted output, as the following example illustrates. ```swift let now = Date() print(now.formatted(Date.ISO8601FormatStyle().dateSeparator(.dash))) // 2021-06-21T211015Z ``` Use the static factory property ``FormatStyle/iso8601`` to create an instance of ``Date/ISO8601FormatStyle``. Then apply instance modifier methods to customize the format, as in the example below. ```swift let meetNow = Date() let formatted = meetNow.formatted(.iso8601 .year() .month() .day() .timeZone(separator: .omitted) .time(includingFractionalSeconds: true) .timeSeparator(.colon) ) // "2022-06-10T12:34:56.789Z" ```
weekOfYear(): Date_ISO8601FormatStylefunc weekOfYear() -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the week of the year in the formatted output. When the format style includes the week of year, the output represents the day as the ordinal day of the week. - Returns: An ISO 8601 date format style modified to include the week of the year.
static initDateSeparatorDateTimeSeparatorTimeSeparatorTimeZoneSeparatorIncludingFractionalSecondsTimeZone(dateSeparator?: Date_ISO8601FormatStyle_DateSeparator, dateTimeSeparator?: Date_ISO8601FormatStyle_DateTimeSeparator, timeSeparator?: Date_ISO8601FormatStyle_TimeSeparator, timeZoneSeparator?: Date_ISO8601FormatStyle_TimeZoneSeparator, includingFractionalSeconds?: boolean, timeZone?: TimeZone): Date_ISO8601FormatStyleinit(dateSeparator: Date.ISO8601FormatStyle.DateSeparator = .dash, dateTimeSeparator: Date.ISO8601FormatStyle.DateTimeSeparator = .standard, timeSeparator: Date.ISO8601FormatStyle.TimeSeparator = .colon, timeZoneSeparator: Date.ISO8601FormatStyle.TimeZoneSeparator = .omitted, includingFractionalSeconds: Bool = false, timeZone: TimeZone = TimeZone(secondsFromGMT: 0)!)static initDateSeparatorDateTimeSeparatorTimeZone(dateSeparator?: Date_ISO8601FormatStyle_DateSeparator, dateTimeSeparator?: Date_ISO8601FormatStyle_DateTimeSeparator, timeZone?: TimeZone): Date_ISO8601FormatStyleinit(dateSeparator: Date.ISO8601FormatStyle.DateSeparator = .dash, dateTimeSeparator: Date.ISO8601FormatStyle.DateTimeSeparator = .standard, timeZone: TimeZone = TimeZone(secondsFromGMT: 0)!)Creates an instance using the provided date separator, date and time components separator, and time zone. Possible values of `dateSeparator` are `dash` and `omitted`. Possible values of `dateTimeSeparator` are `space` and `standard`. ```swift let aDate = Date() print(aDate.formatted(Date.ISO8601FormatStyle(dateSeparator: .omitted, dateTimeSeparator: .standard))) // 20210622T172132Z if let centralStandardTimeZone = TimeZone(identifier: "CST") { print(aDate.formatted(Date.ISO8601FormatStyle(dateSeparator: .dash, dateTimeSeparator: .space, timeZone: centralStandardTimeZone))) } // 2021-06-22 122132-0500 ``` - Parameters: - dateSeparator: The separator character used between the year, month, and day. - dateTimeSeparator: The separator character used between the date and time components. - timeZone: The time zone used to create the string representation of the date.
get dateSeparator(): Date_ISO8601FormatStyle_DateSeparatorvar dateSeparator: Date.ISO8601FormatStyle.DateSeparator { get }The character used to separate the components of a date.
dateSeparator71465(separator: Date_ISO8601FormatStyle_DateSeparator): Date_ISO8601FormatStylefunc dateSeparator(_ separator: Date.ISO8601FormatStyle.DateSeparator) -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to use the specified date separator. Possible values are ``DateSeparator/dash`` and ``DateSeparator/omitted``. The default is ``DateSeparator/omitted``. - Parameter separator: The character used to separate the year, month, and day in a date. - Returns: An ISO 8601 date format style modified to include the specified date separator style.
get parseStrategy(): Date_ISO8601FormatStylevar parseStrategy: Date.ISO8601FormatStyle { get }The strategy used to parse a string into a date.
get timeSeparator(): Date_ISO8601FormatStyle_TimeSeparatorvar timeSeparator: Date.ISO8601FormatStyle.TimeSeparator { get }timeSeparator39321(separator: Date_ISO8601FormatStyle_TimeSeparator): Date_ISO8601FormatStylefunc timeSeparator(_ separator: Date.ISO8601FormatStyle.TimeSeparator) -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to use the specified time separator. Possible values are ``TimeSeparator/colon`` and ``TimeSeparator/omitted``. The default is ``TimeSeparator/omitted``. - Parameter separator: The character used to separate the hour and minute in a date. - Returns: An ISO 8601 date format style modified to include the specified time separator style.
get dateTimeSeparator(): Date_ISO8601FormatStyle_DateTimeSeparatorvar dateTimeSeparator: Date.ISO8601FormatStyle.DateTimeSeparator { get }The character used to separate the date and time components of an ISO 8601 string representation of a date.
dateTimeSeparator23628(separator: Date_ISO8601FormatStyle_DateTimeSeparator): Date_ISO8601FormatStylefunc dateTimeSeparator(_ separator: Date.ISO8601FormatStyle.DateTimeSeparator) -> Date.ISO8601FormatStyleSets the character that separates the date and time components. Possible values are ``DateTimeSeparator/space`` and ``DateTimeSeparator/standard``. The default is ``DateTimeSeparator/standard``. - Parameter separator: The character used to separate the date and time components. - Returns: An ISO 8601 date format style with the provided date and time component separator.
get timeZoneSeparator(): Date_ISO8601FormatStyle_TimeZoneSeparatorvar timeZoneSeparator: Date.ISO8601FormatStyle.TimeZoneSeparator { get }timeZoneSeparator12703(separator: Date_ISO8601FormatStyle_TimeZoneSeparator): Date_ISO8601FormatStylefunc timeZoneSeparator(_ separator: Date.ISO8601FormatStyle.TimeZoneSeparator) -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to use the specified time zone separator. Possible values are ``TimeZoneSeparator/colon`` and ``TimeZoneSeparator/omitted``. - Parameter separator: The character used to separate the time and time zone in a date. - Returns: An ISO 8601 date format style modified to include the specified time zone separator style.
get includingFractionalSeconds(): booleanvar includingFractionalSeconds: Bool { get }If set, the style includes fractional seconds when formatting. Before Swift 6.2, if true when parsing, fractional seconds must be present. If false when parsing, fractional seconds must not be present. After Swift 6.2, fractional seconds may be present in the String regardless of the setting of this property.
day(): Date_ISO8601FormatStylefunc day() -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the day in the formatted output. If `month()` isn't included in the format and `day()` is, the format represents the day as the ordinal date. The default ``Date/ISO8601FormatStyle`` includes the day. - Returns: An ISO 8601 date format style modified to include the day.
time(includingFractionalSeconds: boolean): Date_ISO8601FormatStylefunc time(includingFractionalSeconds: Bool) -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the time in the formatted output. The default ``Date/ISO8601FormatStyle`` includes the time but not the fractional seconds. - Parameter includingFractionalSeconds: Specifies whether the format style includes the fractional component of the seconds. - Returns: An ISO 8601 date format style modified to include the time.
year(): Date_ISO8601FormatStylefunc year() -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the year in the formatted output. The default ``Date/ISO8601FormatStyle`` includes the year. - Returns: An ISO 8601 date format style modified to include the year.
month(): Date_ISO8601FormatStylefunc month() -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the month in the formatted output. If `month()` isn't included in the format but `day()` is, the format represents the day as the ordinal date. The default ``Date/ISO8601FormatStyle`` includes the month. - Returns: An ISO 8601 date format style modified to include the month.
parse(value: string): globalThis.Datefunc parse(_ value: String) throws -> DateParses a string into a date. This method attempts to parse a provided string into an instance of date using the source date format style. The function throws an error if it can't parse the input string into a date instance. ```swift let birthdayFormatStyle = Date.ISO8601FormatStyle() .dateSeparator(.dash) .timeSeparator(.colon) .year() .month() .day() .time(includingFractionalSeconds: false) let yourBirthdayString = "2021-02-17T14:33:25" let yourBirthday = try? birthdayFormatStyle.parse(yourBirthdayString) // Feb 17, 2021 at 8:33 AM ``` - Parameter value: The string to parse. - Returns: An instance of `Date` parsed from the input string.
format(value: globalThis.Date): stringfunc format(_ value: Date) -> StringCreates a locale-aware ISO 8601 string representation from a date value. Once you create a style, you can use it to format dates multiple times. - Parameter value: The date to format. - Returns: A string ISO 8601 representation of the date.
timeZoneSeparator1342(separator: Date_ISO8601FormatStyle_TimeZoneSeparator): Date_ISO8601FormatStylefunc timeZone(separator: Date.ISO8601FormatStyle.TimeZoneSeparator) -> Date.ISO8601FormatStyleModifies the ISO 8601 date format style to include the time zone in the formatted output. The default ``Date/ISO8601FormatStyle`` doesn't include the time zone. - Parameter separator: The character used to separate the time and time zone in a date. - Returns: An ISO 8601 date format style modified to include the time zone.
get timeZone(): TimeZonevar timeZone: TimeZone { get set }The time zone to use to create and parse date representations.
set timeZone(value: TimeZone)var timeZone: TimeZone { get set }The time zone to use to create and parse date representations.
consuming(input: string, index: SDKHandle, bounds: SDKHandle): ({ "upperBound": SDKHandle; "output": globalThis.Date }) | nullfunc consuming(_ input: String, startingAt index: String.Index, in bounds: Range<String.Index>) throws -> (upperBound: String.Index, output: Date)?Processes the input string within the specified bounds, beginning at the given index, and returns the end position of the match and the produced output. Don't call this method directly. Regular expression matching and capture calls it automatically when matching substrings. - Parameters: - input: An input string to match against. - index: The index within `input` at which to begin searching. - bounds: The bounds within `input` in which to search. - Returns: The upper bound where the match terminates and a matched instance, or `nil` if there isn't a match.
No declarations were skipped in this snapshot.